vscode-languageserver-types

constructor

constructor(workspaceEdit?: WorkspaceEdit);

property edit

readonly edit: WorkspaceEdit;

• Returns the underlying WorkspaceEdit literal use to be returned from a workspace edit operation like rename.

method createFile

createFile: {
    (uri: DocumentUri, options?: CreateFileOptions): void;
    (
        uri: string,
        annotation: string | ChangeAnnotation,
        options?: CreateFileOptions
    ): string;
};

method deleteFile

deleteFile: {
    (uri: DocumentUri, options?: DeleteFileOptions): void;
    (
        uri: string,
        annotation: string | ChangeAnnotation,
        options?: DeleteFileOptions
    ): string;
};

method getTextEditChange

getTextEditChange: {
    (textDocument: OptionalVersionedTextDocumentIdentifier): TextEditChange;
    (uri: string): TextEditChange;
};

• Returns the TextEditChange to manage text edits for resources.

method renameFile

renameFile: {
    (
        oldUri: DocumentUri,
        newUri: DocumentUri,
        options?: RenameFileOptions
    ): void;
    (
        oldUri: string,
        newUri: string,
        annotation?: string | ChangeAnnotation,
        options?: RenameFileOptions
    ): string;
};

property annotationId

annotationId: ChangeAnnotationIdentifier;

• The actual identifier of the change annotation

property containerName

containerName?: string;

• The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.

property kind

kind: SymbolKind;

• The kind of this symbol.

property name

name: string;

• The name of this symbol.

property tags

tags?: SymbolTag[];

• Tags for this symbol.

  3.16.0

property from

from: CallHierarchyItem;

• The item that makes the call.

property fromRanges

fromRanges: Range[];

• The ranges at which the calls appear. This is relative to the caller denoted by .

property data

data?: LSPAny;

• A data entry field that is preserved between a call hierarchy prepare and incoming calls or outgoing calls requests.

property detail

detail?: string;

• More detail for this item, e.g. the signature of a function.

property kind

kind: SymbolKind;

• The kind of this item.

property name

name: string;

• The name of this item.

property range

range: Range;

• The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

property selectionRange

selectionRange: Range;

• The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. Must be contained by the .

property tags

tags?: SymbolTag[];

• Tags for this item.

property uri

uri: DocumentUri;

• The resource identifier of this item.

property fromRanges

fromRanges: Range[];

• The range at which this item is called. This is the range relative to the caller, e.g the item passed to and not .

property to

to: CallHierarchyItem;

• The item that is called.

property description

description?: string;

• A human-readable string which is rendered less prominent in the user interface.

property label

label: string;

• A human-readable string describing the actual change. The string is rendered prominent in the user interface.

property needsConfirmation

needsConfirmation?: boolean;

• A flag which indicates that user confirmation is needed before applying the change.

property command

command?: Command;

• A command this code action executes. If a code action provides an edit and a command, first the edit is executed and then the command.

property data

data?: LSPAny;

• A data entry field that is preserved on a code action between a textDocument/codeAction and a codeAction/resolve request.

  3.16.0

property diagnostics

diagnostics?: Diagnostic[];

• The diagnostics that this code action resolves.

property disabled

disabled?: {
    /**
     * Human readable description of why the code action is currently disabled.
     *
     * This is displayed in the code actions UI.
     */
    reason: string;
};

• Marks that the code action cannot currently be applied.

  Clients should follow the following guidelines regarding disabled code actions:

  - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) code action menus.

  - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type of code action, such as refactorings.

  - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions) that auto applies a code action and only disabled code actions are returned, the client should show the user an error message with reason in the editor.

  3.16.0

property edit

edit?: WorkspaceEdit;

• The workspace edit this code action performs.

property isPreferred

isPreferred?: boolean;

• Marks this as a preferred action. Preferred actions are used by the auto fix command and can be targeted by keybindings.

  A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take.

  3.15.0

property kind

kind?: CodeActionKind;

• The kind of the code action.

  Used to filter code actions.

property title

title: string;

• A short, human-readable, title for this code action.

property diagnostics

diagnostics: Diagnostic[];

• An array of diagnostics known on the client side overlapping the range provided to the textDocument/codeAction request. They are provided so that the server knows which errors are currently presented to the user for the given range. There is no guarantee that these accurately reflect the error state of the resource. The primary parameter to compute code actions is the provided range.

property only

only?: CodeActionKind[];

• Requested kind of actions to return.

  Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them.

property triggerKind

triggerKind?: CodeActionTriggerKind;

• The reason why code actions were requested.

  3.17.0

property href

href: URI;

• An URI to open with more information about the diagnostic error.

property command

command?: Command;

• The command this code lens represents.

property data

data?: LSPAny;

• A data entry field that is preserved on a code lens item between a CodeLensRequest and a CodeLensResolveRequest

property range

range: Range;

• The range in which this code lens is valid. Should only span a single line.

property alpha

readonly alpha: decimal;

• The alpha component of this color in the range [0-1].

property blue

readonly blue: decimal;

• The blue component of this color in the range [0-1].

property green

readonly green: decimal;

• The green component of this color in the range [0-1].

property red

readonly red: decimal;

• The red component of this color in the range [0-1].

property color

color: Color;

• The actual color value for this color range.

property range

range: Range;

• The range in the document where this color appears.

property additionalTextEdits

additionalTextEdits?: TextEdit[];

• An optional array of additional that are applied when selecting this color presentation. Edits must not overlap with the main nor with themselves.

property label

label: string;

• The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.

property textEdit

textEdit?: TextEdit;

• An which is applied to a document when selecting this presentation for the color. When falsy the is used.

property arguments

arguments?: LSPAny[];

• Arguments that the command handler should be invoked with.

property command

command: string;

• The identifier of the actual command handler.

property title

title: string;

• Title of the command, like save.

property additionalTextEdits

additionalTextEdits?: TextEdit[];

• An optional array of additional that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main nor with themselves.

  Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

property command

command?: Command;

• An optional that is executed *after* inserting this completion. *Note* that additional modifications to the current document should be described with the -property.

property commitCharacters

commitCharacters?: string[];

• An optional set of characters that when pressed while this completion is active will accept it first and then type that character. *Note* that all commit characters should have length=1 and that superfluous characters will be ignored.

property data

data?: LSPAny;

• A data entry field that is preserved on a completion item between a CompletionRequest and a CompletionResolveRequest.

property deprecated

deprecated?: boolean;

• Indicates if this item is deprecated.

  Deprecated

  Use tags instead.

property detail

detail?: string;

• A human-readable string with additional information about this item, like type or symbol information.

property documentation

documentation?: string | MarkupContent;

• A human-readable string that represents a doc-comment.

property filterText

filterText?: string;

• A string that should be used when filtering a set of completion items. When falsy the is used.

property insertText

insertText?: string;

• A string that should be inserted into a document when selecting this completion. When falsy the is used.

  The insertText is subject to interpretation by the client side. Some tools might not take the string literally. For example VS Code when code complete is requested in this example con<cursor position> and a completion item with an insertText of console is provided it will only insert sole. Therefore it is recommended to use textEdit instead since it avoids additional client side interpretation.

property insertTextFormat

insertTextFormat?: InsertTextFormat;

• The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit. If omitted defaults to InsertTextFormat.PlainText.

  Please note that the insertTextFormat doesn't apply to additionalTextEdits.

property insertTextMode

insertTextMode?: InsertTextMode;

• How whitespace and indentation is handled during completion item insertion. If not provided the clients default value depends on the textDocument.completion.insertTextMode client capability.

  3.16.0

property kind

kind?: CompletionItemKind;

• The kind of this completion item. Based of the kind an icon is chosen by the editor.

property label

label: string;

• The label of this completion item.

  The label property is also by default the text that is inserted when selecting this completion.

  If label details are provided the label itself should be an unqualified name of the completion item.

property labelDetails

labelDetails?: CompletionItemLabelDetails;

• Additional details for the label

  3.17.0

property preselect

preselect?: boolean;

• Select this item when showing.

  *Note* that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the *first* item of those that match best is selected.

property sortText

sortText?: string;

• A string that should be used when comparing this item with other items. When falsy the is used.

property tags

tags?: CompletionItemTag[];

• Tags for this completion item.

  3.15.0

property textEdit

textEdit?: TextEdit | InsertReplaceEdit;

• An which is applied to a document when selecting this completion. When an edit is provided the value of is ignored.

  Most editors support two different operations when accepting a completion item. One is to insert a completion text and the other is to replace an existing text with a completion text. Since this can usually not be predetermined by a server it can report both ranges. Clients need to signal support for InsertReplaceEdits via the textDocument.completion.insertReplaceSupport client capability property.

  *Note 1:* The text edit's range as well as both ranges from an insert replace edit must be a [single line] and they must contain the position at which completion has been requested. *Note 2:* If an InsertReplaceEdit is returned the edit's insert range must be a prefix of the edit's replace range, that means it must be contained and starting at the same position.

  3.16.0 additional type InsertReplaceEdit

property textEditText

textEditText?: string;

• The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.

  Clients will only honor this property if they opt into completion list item defaults using the capability completionList.itemDefaults.

  If not provided and a list's default range is provided the label property is used as a text.

  3.17.0

property description

description?: string;

• An optional string which is rendered less prominently after CompletionItem.detail. Should be used for fully qualified names and file paths.

property detail

detail?: string;

• An optional string which is rendered less prominently directly after , without any spacing. Should be used for function signatures and type annotations.

property isIncomplete

isIncomplete: boolean;

• This list it not complete. Further typing results in recomputing this list.

  Recomputed lists have all their items replaced (not appended) in the incomplete completion sessions.

property itemDefaults

itemDefaults?: {
    /**
     * A default commit character set.
     *
     * @since 3.17.0
     */
    commitCharacters?: string[];
    /**
     * A default edit range.
     *
     * @since 3.17.0
     */
    editRange?:
        | Range
        | {
              insert: Range;
              replace: Range;
          };
    /**
     * A default insert text format.
     *
     * @since 3.17.0
     */
    insertTextFormat?: InsertTextFormat;
    /**
     * A default insert text mode.
     *
     * @since 3.17.0
     */
    insertTextMode?: InsertTextMode;
    /**
     * A default data value.
     *
     * @since 3.17.0
     */
    data?: LSPAny;
};

• In many cases the items of an actual completion result share the same value for properties like commitCharacters or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.

  If a completion list specifies a default value and a completion item also specifies a corresponding value the one from the item is used.

  Servers are only allowed to return default values if the client signals support for this via the completionList.itemDefaults capability.

  3.17.0

property items

items: CompletionItem[];

• The completion items.

property kind

kind: 'create';

• A create

property options

options?: CreateFileOptions;

• Additional options

property uri

uri: DocumentUri;

• The resource to create.

property ignoreIfExists

ignoreIfExists?: boolean;

• Ignore if exists.

property overwrite

overwrite?: boolean;

• Overwrite existing file. Overwrite wins over ignoreIfExists

property kind

kind: 'delete';

• A delete

property options

options?: DeleteFileOptions;

• Delete options.

property uri

uri: DocumentUri;

• The file to delete.

property ignoreIfNotExists

ignoreIfNotExists?: boolean;

• Ignore the operation if the file doesn't exist.

property recursive

recursive?: boolean;

• Delete the content recursively if a folder is denoted.

property code

code?: integer | string;

• The diagnostic's code, which usually appear in the user interface.

property codeDescription

codeDescription?: CodeDescription;

• An optional property to describe the error code. Requires the code field (above) to be present/not null.

  3.16.0

property data

data?: LSPAny;

• A data entry field that is preserved between a textDocument/publishDiagnostics notification and textDocument/codeAction request.

  3.16.0

property message

message: string;

• The diagnostic's message. It usually appears in the user interface

property range

range: Range;

• The range at which the message applies

property relatedInformation

relatedInformation?: DiagnosticRelatedInformation[];

• An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

property severity

severity?: DiagnosticSeverity;

• The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

property source

source?: string;

• A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'. It usually appears in the user interface.

property tags

tags?: DiagnosticTag[];

• Additional metadata about the diagnostic.

  3.15.0

property location

location: Location;

• The location of this related diagnostic information.

property message

message: string;

• The message of this related diagnostic information.

property kind

kind?: DocumentHighlightKind;

• The highlight kind, default is .

property range

range: Range;

• The range this highlight applies to.

property data

data?: LSPAny;

• A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.

property range

range: Range;

• The range this link applies to.

property target

target?: URI;

• The uri this link points to. If missing a resolve request is sent later.

property tooltip

tooltip?: string;

• The tooltip text when you hover over this link.

  If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as {0} (ctrl + click). The specific instructions vary depending on OS, user settings, and localization.

  3.15.0

property children

children?: DocumentSymbol[];

• Children of this symbol, e.g. properties of a class.

property deprecated

deprecated?: boolean;

• Indicates if this symbol is deprecated.

  Deprecated

  Use tags instead

property detail

detail?: string;

• More detail for this symbol, e.g the signature of a function.

property kind

kind: SymbolKind;

• The kind of this symbol.

property name

name: string;

• The name of this symbol. Will be displayed in the user interface and therefore must not be an empty string or a string only consisting of white spaces.

property range

range: Range;

• The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI.

property selectionRange

selectionRange: Range;

• The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the range.

property tags

tags?: SymbolTag[];

• Tags for this document symbol.

  3.16.0

property collapsedText

collapsedText?: string;

• The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client.

  3.17.0

property endCharacter

endCharacter?: uinteger;

• The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.

property endLine

endLine: uinteger;

• The zero-based end line of the range to fold. The folded area ends with the line's last character. To be valid, the end must be zero or larger and smaller than the number of lines in the document.

property kind

kind?: FoldingRangeKind;

• Describes the kind of the folding range such as `comment' or 'region'. The kind is used to categorize folding ranges and used by commands like 'Fold all comments'. See FoldingRangeKind for an enumeration of standardized kinds.

property startCharacter

startCharacter?: uinteger;

• The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.

property startLine

startLine: uinteger;

• The zero-based start line of the range to fold. The folded area starts after the line's last character. To be valid, the end must be zero or larger and smaller than the number of lines in the document.

property insertFinalNewline

insertFinalNewline?: boolean;

• Insert a newline character at the end of the file if one does not exist.

  3.15.0

property insertSpaces

insertSpaces: boolean;

• Prefer spaces over tabs.

property tabSize

tabSize: uinteger;

• Size of a tab in spaces.

property trimFinalNewlines

trimFinalNewlines?: boolean;

• Trim all newlines after the final newline at the end of the file.

  3.15.0

property trimTrailingWhitespace

trimTrailingWhitespace?: boolean;

• Trim trailing whitespace on a line.

  3.15.0

index signature

[key: string]: boolean | integer | string | undefined;

• Signature for further properties.

property contents

contents: MarkupContent | MarkedString | MarkedString[];

• The hover's content

property range

range?: Range;

• An optional range inside the text document that is used to visualize the hover, e.g. by changing the background color.

property selectedCompletionInfo

selectedCompletionInfo?: SelectedCompletionInfo;

• Provides information about the currently selected item in the autocomplete widget if it is visible.

property triggerKind

triggerKind: InlineCompletionTriggerKind;

• Describes how the inline completion was triggered.

property command

command?: Command;

• An optional Command that is executed *after* inserting this completion.

property filterText

filterText?: string;

• A text that is used to decide if this inline completion should be shown. When falsy the InlineCompletionItem.insertText is used.

property insertText

insertText: string | StringValue;

• The text to replace the range with. Must be set.

property range

range?: Range;

• The range to replace. Must begin and end on the same line.

property items

items: InlineCompletionItem[];

• The inline completion items

property insert

insert: Range;

• The range if the insert is requested

property newText

newText: string;

• The string to be inserted.

property replace

replace: Range;

• The range if the replace is requested.

property range

range: Range;

property uri

uri: DocumentUri;

property originSelectionRange

originSelectionRange?: Range;

• Span of the origin of this link.

  Used as the underlined span for mouse interaction. Defaults to the word range at the definition position.

property targetRange

targetRange: Range;

• The full target range of this link. If the target for example is a symbol then target range is the range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to highlight the range in the editor.

property targetSelectionRange

targetSelectionRange: Range;

• The range that should be selected and revealed when this link is being followed, e.g the name of a function. Must be contained by the targetRange. See also DocumentSymbol#range

property targetUri

targetUri: DocumentUri;

• The target resource identifier of this link.

property kind

kind: MarkupKind;

• The type of the Markup

property value

value: string;

• The content itself

property version

version: integer | null;

• The version number of this document. If a versioned text document identifier is sent from the server to the client and the file is not open in the editor (the server has not received an open notification before) the server can send null to indicate that the version is unknown and the content on disk is the truth (as specified with document content ownership).

property documentation

documentation?: string | MarkupContent;

• The human-readable doc-comment of this parameter. Will be shown in the UI but can be omitted.

property label

label: string | [uinteger, uinteger];

• The label of this parameter information.

  Either a string or an inclusive start and exclusive end offsets within its containing signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 string representation as Position and Range does.

  *Note*: a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation.label.

property character

character: uinteger;

• Character offset on a line in a document (zero-based).

  The meaning of this offset is determined by the negotiated PositionEncodingKind.

  If the character value is greater than the line length it defaults back to the line length.

property line

line: uinteger;

• Line position in a document (zero-based).

  If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document. If a line number is negative, it defaults to 0.

property end

end: Position;

• The range's end position.

property start

start: Position;

• The range's start position.

property includeDeclaration

includeDeclaration: boolean;

• Include the declaration of the current symbol.

property kind

kind: 'rename';

• A rename

property newUri

newUri: DocumentUri;

• The new location.

property oldUri

oldUri: DocumentUri;

• The old (existing) location.

property options

options?: RenameFileOptions;

• Rename options.

property ignoreIfExists

ignoreIfExists?: boolean;

• Ignores if target exists.

property overwrite

overwrite?: boolean;

• Overwrite target if existing. Overwrite wins over ignoreIfExists

property range

range: Range;

• The range that will be replaced if this completion item is accepted.

property text

text: string;

• The text the range will be replaced with if this completion is accepted.

property parent

parent?: SelectionRange;

• The parent selection range containing this range. Therefore parent.range must contain this.range.

property range

range: Range;

• The of this selection range.

property data

data: uinteger[];

• The actual tokens.

property resultId

resultId?: string;

• An optional result id. If provided and clients support delta updating the client will include the result id in the next semantic token request. A server can then instead of computing all semantic tokens again simply send a delta.

property edits

edits: SemanticTokensEdit[];

• The semantic token edits to transform a previous result into a new result.

property resultId

readonly resultId?: string;

property data

data?: uinteger[];

• The elements to insert.

property deleteCount

deleteCount: uinteger;

• The count of elements to remove.

property start

start: uinteger;

• The start offset of the edit.

property tokenModifiers

tokenModifiers: string[];

• The token modifiers a server uses.

property tokenTypes

tokenTypes: string[];

• The token types a server uses.

property activeParameter

activeParameter?: uinteger;

• The active parameter of the active signature. If omitted or the value lies outside the range of signatures[activeSignature].parameters defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored. In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.

property activeSignature

activeSignature?: uinteger;

• The active signature. If omitted or the value lies outside the range of signatures the value defaults to zero or is ignored if the SignatureHelp has no signatures.

  Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value.

  In future version of the protocol this property might become mandatory to better express this.

property signatures

signatures: SignatureInformation[];

• One or more signatures.

property activeParameter

activeParameter?: uinteger;

• The index of the active parameter.

  If provided, this is used in place of SignatureHelp.activeParameter.

  3.16.0

property documentation

documentation?: string | MarkupContent;

• The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

property label

label: string;

• The label of this signature. Will be shown in the UI.

property parameters

parameters?: ParameterInformation[];

• The parameters of this signature.

property kind

kind: 'snippet';

• The kind of string value.

property value

value: string;

• The snippet string.

property deprecated

deprecated?: boolean;

• Indicates if this symbol is deprecated.

  Deprecated

  Use tags instead

property location

location: Location;

• The location of this symbol. The location's range is used by a tool to reveal the location in the editor. If the symbol is selected in the tool the range's start information is used to position the cursor. So the range usually spans more than the actual symbol's name and does normally include things like visibility modifiers.

  The range doesn't have to denote a node range in the sense of an abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.

property languageId

readonly languageId: string;

• The identifier of the language associated with this document.

  Modifiers

  • @readonly

property lineCount

readonly lineCount: uinteger;

• The number of lines in this document.

  Modifiers

  • @readonly

property uri

readonly uri: DocumentUri;