Interface CodeLensProvider<T>

A code lens provider adds commands to source text. The commands will be shown as dedicated horizontal lines in between the source text.

interface CodeLensProvider<T> {
    onDidChangeCodeLenses?: Event<void>;
    provideCodeLenses(document, token): ProviderResult<T[]>;
    resolveCodeLens?(codeLens, token): ProviderResult<T>;
}

Type Parameters

Properties

onDidChangeCodeLenses?: Event<void>

An optional event to signal that the code lenses from this provider have changed.

Methods

  • Compute a list of lenses. This call should return as fast as possible and if computing the commands is expensive implementors should only return code lens objects with the range set and implement resolve.

    Parameters

    Returns ProviderResult<T[]>

    An array of code lenses or a thenable that resolves to such. The lack of a result can be signaled by returning undefined, null, or an empty array.