Interface DocumentSymbolProvider

The document symbol provider interface defines the contract between extensions and the go to symbol-feature.

interface DocumentSymbolProvider {
    displayName?: string;
    provideDocumentSymbols(
        model: ITextModel,
        token: CancellationToken,
    ): ProviderResult<DocumentSymbol[]>;
}

Index

Properties

Methods

provideDocumentSymbols

Properties

`Optional`displayName

displayName?: string

Methods

provideDocumentSymbols

provideDocumentSymbols(
model: ITextModel,
token: CancellationToken,
): ProviderResult<DocumentSymbol[]>
Provide symbol information for the given document.
Parameters
- model: ITextModel
- token: CancellationToken
Returns ProviderResult<DocumentSymbol[]>
- Defined in src/components/monaco/bin/monaco.d.ts:8077