Class SemanticTokensBuilder

A semantic tokens builder can help with creating a SemanticTokens instance which contains delta encoded semantic tokens.

Hierarchy

SemanticTokensBuilder

Index

Constructors（1）

constructor

Methods（2）

push
build

Constructors（1）

constructor

new SemanticTokensBuilder(legend?: SemanticTokensLegend): SemanticTokensBuilder

- Defined in vscode.d.ts:4215
Creates a semantic tokens builder.

Parameters
- Optional legend: SemanticTokensLegend
  
  A semantic tokens legent.
Returns SemanticTokensBuilder

Methods（2）

push

push(line: number, char: number, length: number, tokenType: number, tokenModifiers?: number): void
push(range: Range, tokenType: string, tokenModifiers?: readonly string[]): void

- Defined in vscode.d.ts:4226
Add another token.

Parameters
- line: number
  
  The token start line number (absolute value).
- char: number
  
  The token start character (absolute value).
- length: number
  
  The token length in characters.
- tokenType: number
  
  The encoded token type.
- Optional tokenModifiers: number
  
  The encoded token modifiers.
Returns void
- Defined in vscode.d.ts:4235
Add another token. Use only when providing a legend.

Parameters
- range: Range
  
  The range of the token. Must be single-line.
- tokenType: string
  
  The token type.
- Optional tokenModifiers: readonly string[]
  
  The token modifiers.
Returns void

build

build(resultId?: string): SemanticTokens

- Defined in vscode.d.ts:4240
Finish and create a SemanticTokens instance.

Parameters
- Optional resultId: string
Returns SemanticTokens

Generated by TypeDoc. Maintained by 紫升

Links: 搜外友链, 69中文网