Interface SemanticTokenProvider

interface SemanticTokenProvider {
    semanticTokensOptions: SemanticTokensOptions;
    tokenModifiers: Record<string, number>;
    tokenTypes: Record<string, number>;
    semanticHighlight(document: LangiumDocument<AstNode>, params: SemanticTokensParams, cancelToken?: CancellationToken): MaybePromise<SemanticTokens>;
    semanticHighlightDelta(document: LangiumDocument<AstNode>, params: SemanticTokensDeltaParams, cancelToken?: CancellationToken): MaybePromise<SemanticTokens | SemanticTokensDelta>;
    semanticHighlightRange(document: LangiumDocument<AstNode>, params: SemanticTokensRangeParams, cancelToken?: CancellationToken): MaybePromise<SemanticTokens>;
}

Implemented by

AbstractSemanticTokenProvider

Index

Properties

semanticTokensOptions tokenModifiers tokenTypes

Methods

semanticHighlight semanticHighlightDelta semanticHighlightRange

Properties

`Readonly`semanticTokensOptions

semanticTokensOptions: SemanticTokensOptions

`Readonly`tokenModifiers

tokenModifiers: Record<string, number>

`Readonly`tokenTypes

tokenTypes: Record<string, number>

Methods

semanticHighlight

semanticHighlight(document, params, cancelToken?): MaybePromise<SemanticTokens>
Parameters
- document: LangiumDocument<AstNode>
- params: SemanticTokensParams
- OptionalcancelToken: CancellationToken
Returns MaybePromise<SemanticTokens>
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:72

semanticHighlightDelta

semanticHighlightDelta(document, params, cancelToken?): MaybePromise<SemanticTokens | SemanticTokensDelta>
Parameters
- document: LangiumDocument<AstNode>
- params: SemanticTokensDeltaParams
- OptionalcancelToken: CancellationToken
Returns MaybePromise<SemanticTokens | SemanticTokensDelta>
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:74

semanticHighlightRange

semanticHighlightRange(document, params, cancelToken?): MaybePromise<SemanticTokens>
Parameters
- document: LangiumDocument<AstNode>
- params: SemanticTokensRangeParams
- OptionalcancelToken: CancellationToken
Returns MaybePromise<SemanticTokens>
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:73