vscode-languageserver-protocol

vscode-languageserver-protocol

Version 3.17.5
Published 1 year ago
365 kB
2 dependencies
MIT license

Install

npm i vscode-languageserver-protocol

yarn add vscode-languageserver-protocol

pnpm add vscode-languageserver-protocol

Overview

VSCode Language Server Protocol implementation

Index

Functions

function createProtocolConnection

createProtocolConnection: (
    input: MessageReader,
    output: MessageWriter,
    logger?: Logger,
    options?: ConnectionStrategy | ConnectionOptions
) => ProtocolConnection;

Classes

class ProtocolNotificationType

class ProtocolNotificationType<P, RO>
    extends NotificationType<P>
    implements RegistrationType<RO> {}

constructor

constructor(method: string);

class ProtocolNotificationType0

class ProtocolNotificationType0<RO>
    extends NotificationType0
    implements RegistrationType<RO> {}

constructor

constructor(method: string);

class ProtocolRequestType

class ProtocolRequestType<P, R, PR, E, RO>
    extends RequestType<P, R, E>
    implements ProgressType<PR>, RegistrationType<RO> {}

constructor

constructor(method: string);

class ProtocolRequestType0

class ProtocolRequestType0<R, PR, E, RO>
    extends RequestType0<R, E>
    implements ProgressType<PR>, RegistrationType<RO> {}

constructor

constructor(method: string);

class RegistrationType

class RegistrationType<RO> {}

constructor

constructor(method: string);

property method

readonly method: string;

Interfaces

interface ApplyWorkspaceEditParams

interface ApplyWorkspaceEditParams {}

The parameters passed via an apply workspace edit request.

property edit

edit: WorkspaceEdit;

The edits to apply.

property label

label?: string;

An optional label of the workspace edit. This label is presented in the user interface for example on an undo stack to undo the workspace edit.

interface ApplyWorkspaceEditResult

interface ApplyWorkspaceEditResult {}

The result returned from the apply workspace edit request.
3.17 renamed from ApplyWorkspaceEditResponse

property applied

applied: boolean;

Indicates whether the edit was applied or not.

property failedChange

failedChange?: uinteger;

Depending on the client's failure handling strategy failedChange might contain the index of the change that failed. This property is only available if the client signals a failureHandlingStrategy in its client capabilities.

property failureReason

failureReason?: string;

An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.

interface CallHierarchyClientCapabilities

interface CallHierarchyClientCapabilities {}

3.16.0

property dynamicRegistration

dynamicRegistration?: boolean;

Whether implementation supports dynamic registration. If this is set to true the client supports the new (TextDocumentRegistrationOptions & StaticRegistrationOptions) return value for the corresponding server capability as well.

interface CallHierarchyIncomingCallsParams

interface CallHierarchyIncomingCallsParams
    extends WorkDoneProgressParams,
        PartialResultParams {}

The parameter of a callHierarchy/incomingCalls request.
3.16.0

property item

item: CallHierarchyItem;

interface CallHierarchyOptions

interface CallHierarchyOptions extends WorkDoneProgressOptions {}

Call hierarchy options used during static registration.
3.16.0

interface CallHierarchyOutgoingCallsParams

interface CallHierarchyOutgoingCallsParams
    extends WorkDoneProgressParams,
        PartialResultParams {}

The parameter of a callHierarchy/outgoingCalls request.
3.16.0

property item

item: CallHierarchyItem;

interface CallHierarchyPrepareParams

interface CallHierarchyPrepareParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams {}

The parameter of a textDocument/prepareCallHierarchy request.
3.16.0

interface CallHierarchyRegistrationOptions

interface CallHierarchyRegistrationOptions
    extends TextDocumentRegistrationOptions,
        CallHierarchyOptions,
        StaticRegistrationOptions {}

Call hierarchy options used during static or dynamic registration.
3.16.0

interface ClientCapabilities

interface ClientCapabilities {}

Defines the capabilities provided by the client.

property experimental

experimental?: LSPAny;

Experimental client capabilities.

property general

general?: GeneralClientCapabilities;

General client capabilities.
3.16.0

property notebookDocument

notebookDocument?: NotebookDocumentClientCapabilities;

Capabilities specific to the notebook document support.
3.17.0

property textDocument

textDocument?: TextDocumentClientCapabilities;

Text document specific client capabilities.

property window

window?: WindowClientCapabilities;

Window specific client capabilities.

property workspace

workspace?: WorkspaceClientCapabilities;

Workspace specific client capabilities.

interface CodeActionClientCapabilities

interface CodeActionClientCapabilities {}

The Client Capabilities of a CodeActionRequest.

property codeActionLiteralSupport

codeActionLiteralSupport?: {
    /**
     * The code action kind is support with the following value
     * set.
     */
    codeActionKind: {
        /**
         * The code action kind values the client supports. When this
         * property exists the client also guarantees that it will
         * handle values outside its set gracefully and falls back
         * to a default value when unknown.
         */
        valueSet: CodeActionKind[];
    };
};

The client support code action literals of type CodeAction as a valid response of the textDocument/codeAction request. If the property is not set the request can only return Command literals.
3.8.0

property dataSupport

dataSupport?: boolean;

Whether code action supports the data property which is preserved between a textDocument/codeAction and a codeAction/resolve request.
3.16.0

property disabledSupport

disabledSupport?: boolean;

Whether code action supports the disabled property.
3.16.0

property dynamicRegistration

dynamicRegistration?: boolean;

Whether code action supports dynamic registration.

property honorsChangeAnnotations

honorsChangeAnnotations?: boolean;

Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.
3.16.0

property isPreferredSupport

isPreferredSupport?: boolean;

Whether code action supports the isPreferred property.
3.15.0

property resolveSupport

resolveSupport?: {
    /**
     * The properties that a client can resolve lazily.
     */
    properties: string[];
};

Whether the client supports resolving additional code action properties via a separate codeAction/resolve request.
3.16.0

interface CodeActionOptions

interface CodeActionOptions extends WorkDoneProgressOptions {}

Provider options for a CodeActionRequest.

property codeActionKinds

codeActionKinds?: CodeActionKind[];

CodeActionKinds that this server may return.
The list of kinds may be generic, such as CodeActionKind.Refactor, or the server may list out every specific kind they provide.

property resolveProvider

resolveProvider?: boolean;

The server provides support to resolve additional information for a code action.
3.16.0

interface CodeActionParams

interface CodeActionParams extends WorkDoneProgressParams, PartialResultParams {}

The parameters of a CodeActionRequest.

property context

context: CodeActionContext;

Context carrying additional information.

property range

range: Range;

The range for which the command was invoked.

property textDocument

textDocument: TextDocumentIdentifier;

The document in which the command was invoked.

interface CodeActionRegistrationOptions

interface CodeActionRegistrationOptions
    extends TextDocumentRegistrationOptions,
        CodeActionOptions {}

Registration options for a CodeActionRequest.

interface CodeLensClientCapabilities

interface CodeLensClientCapabilities {}

The client capabilities of a CodeLensRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether code lens supports dynamic registration.

interface CodeLensOptions

interface CodeLensOptions extends WorkDoneProgressOptions {}

Code Lens provider options of a CodeLensRequest.

property resolveProvider

resolveProvider?: boolean;

Code lens has a resolve provider as well.

interface CodeLensParams

interface CodeLensParams extends WorkDoneProgressParams, PartialResultParams {}

The parameters of a CodeLensRequest.

property textDocument

textDocument: TextDocumentIdentifier;

The document to request code lens for.

interface CodeLensRegistrationOptions

interface CodeLensRegistrationOptions
    extends TextDocumentRegistrationOptions,
        CodeLensOptions {}

Registration options for a CodeLensRequest.

interface CodeLensWorkspaceClientCapabilities

interface CodeLensWorkspaceClientCapabilities {}

3.16.0

property refreshSupport

refreshSupport?: boolean;

Whether the client implementation supports a refresh request sent from the server to the client.
Note that this event is global and will force the client to refresh all code lenses currently shown. It should be used with absolute care and is useful for situation where a server for example detect a project wide change that requires such a calculation.

interface ColorOptions

interface DocumentColorOptions extends WorkDoneProgressOptions {}

interface ColorPresentationParams

interface ColorPresentationParams
    extends WorkDoneProgressParams,
        PartialResultParams {}

Parameters for a ColorPresentationRequest.

property color

color: Color;

The color to request presentations for.

property range

range: Range;

The range where the color would be inserted. Serves as a context.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface ColorProviderOptions

interface DocumentColorOptions extends WorkDoneProgressOptions {}

interface ColorRegistrationOptions

interface DocumentColorRegistrationOptions
    extends TextDocumentRegistrationOptions,
        StaticRegistrationOptions,
        DocumentColorOptions {}

interface CompletionClientCapabilities

interface CompletionClientCapabilities {}

Completion client capabilities

property completionItem

completionItem?: {
    /**
     * Client supports snippets as insert text.
     *
     * A snippet can define tab stops and placeholders with `$1`, `$2`
     * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
     * the end of the snippet. Placeholders with equal identifiers are linked,
     * that is typing in one will update others too.
     */
    snippetSupport?: boolean;
    /**
     * Client supports commit characters on a completion item.
     */
    commitCharactersSupport?: boolean;
    /**
     * Client supports the following content formats for the documentation
     * property. The order describes the preferred format of the client.
     */
    documentationFormat?: MarkupKind[];
    /**
     * Client supports the deprecated property on a completion item.
     */
    deprecatedSupport?: boolean;
    /**
     * Client supports the preselect property on a completion item.
     */
    preselectSupport?: boolean;
    /**
     * Client supports the tag property on a completion item. Clients supporting
     * tags have to handle unknown tags gracefully. Clients especially need to
     * preserve unknown tags when sending a completion item back to the server in
     * a resolve call.
     *
     * @since 3.15.0
     */
    tagSupport?: {
        /**
         * The tags supported by the client.
         */
        valueSet: CompletionItemTag[];
    };
    /**
     * Client support insert replace edit to control different behavior if a
     * completion item is inserted in the text or should replace text.
     *
     * @since 3.16.0
     */
    insertReplaceSupport?: boolean;
    /**
     * Indicates which properties a client can resolve lazily on a completion
     * item. Before version 3.16.0 only the predefined properties `documentation`
     * and `details` could be resolved lazily.
     *
     * @since 3.16.0
     */
    resolveSupport?: {
        /**
         * The properties that a client can resolve lazily.
         */
        properties: string[];
    };
    /**
     * The client supports the `insertTextMode` property on
     * a completion item to override the whitespace handling mode
     * as defined by the client (see `insertTextMode`).
     *
     * @since 3.16.0
     */
    insertTextModeSupport?: {
        valueSet: InsertTextMode[];
    };
    /**
     * The client has support for completion item label
     * details (see also `CompletionItemLabelDetails`).
     *
     * @since 3.17.0
     */
    labelDetailsSupport?: boolean;
};

The client supports the following CompletionItem specific capabilities.

property completionItemKind

completionItemKind?: {
    /**
     * The completion item kind values the client supports. When this
     * property exists the client also guarantees that it will
     * handle values outside its set gracefully and falls back
     * to a default value when unknown.
     *
     * If this property is not present the client only supports
     * the completion items kinds from `Text` to `Reference` as defined in
     * the initial version of the protocol.
     */
    valueSet?: CompletionItemKind[];
};

property completionList

completionList?: {
    /**
     * The client supports the following itemDefaults on
     * a completion list.
     *
     * The value lists the supported property names of the
     * `CompletionList.itemDefaults` object. If omitted
     * no properties are supported.
     *
     * @since 3.17.0
     */
    itemDefaults?: string[];
};

The client supports the following CompletionList specific capabilities.
3.17.0

property contextSupport

contextSupport?: boolean;

The client supports to send additional context information for a textDocument/completion request.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether completion supports dynamic registration.

property insertTextMode

insertTextMode?: InsertTextMode;

Defines how the client handles whitespace and indentation when accepting a completion item that uses multi line text in either insertText or textEdit.
3.17.0

interface CompletionContext

interface CompletionContext {}

Contains additional information about the context in which a completion request is triggered.

property triggerCharacter

triggerCharacter?: string;

The trigger character (a single character) that has trigger code complete. Is undefined if triggerKind !== CompletionTriggerKind.TriggerCharacter

property triggerKind

triggerKind: CompletionTriggerKind;

How the completion was triggered.

interface CompletionOptions

interface CompletionOptions extends WorkDoneProgressOptions {}

Completion options.

property allCommitCharacters

allCommitCharacters?: string[];

The list of all possible characters that commit a completion. This field can be used if clients don't support individual commit characters per completion item. See ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport
If a server provides both allCommitCharacters and commit characters on an individual completion item the ones on the completion item win.
3.2.0

property completionItem

completionItem?: {
    /**
     * The server has support for completion item label
     * details (see also `CompletionItemLabelDetails`) when
     * receiving a completion item in a resolve call.
     *
     * @since 3.17.0
     */
    labelDetailsSupport?: boolean;
};

The server supports the following CompletionItem specific capabilities.
3.17.0

property resolveProvider

resolveProvider?: boolean;

The server provides support to resolve additional information for a completion item.

property triggerCharacters

triggerCharacters?: string[];

Most tools trigger completion request automatically without explicitly requesting it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user starts to type an identifier. For example if the user types c in a JavaScript file code complete will automatically pop up present console besides others as a completion item. Characters that make up identifiers don't need to be listed here.
If code complete should automatically be trigger on characters not being valid inside an identifier (for example . in JavaScript) list them in triggerCharacters.

interface CompletionParams

interface CompletionParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

Completion parameters

property context

context?: CompletionContext;

The completion context. This is only available it the client specifies to send this using the client capability textDocument.completion.contextSupport === true

interface CompletionRegistrationOptions

interface CompletionRegistrationOptions
    extends TextDocumentRegistrationOptions,
        CompletionOptions {}

Registration options for a CompletionRequest.

interface ConfigurationItem

interface ConfigurationItem {}

property scopeUri

scopeUri?: URI;

The scope to get the configuration section for.

property section

section?: string;

The configuration section asked for.

interface ConfigurationParams

interface ConfigurationParams {}

The parameters of a configuration request.

property items

items: ConfigurationItem[];

interface CreateFilesParams

interface CreateFilesParams {}

The parameters sent in notifications/requests for user-initiated creation of files.
3.16.0

property files

files: FileCreate[];

An array of all files/folders created in this operation.

interface DeclarationClientCapabilities

interface DeclarationClientCapabilities {}

3.14.0

property dynamicRegistration

dynamicRegistration?: boolean;

Whether declaration supports dynamic registration. If this is set to true the client supports the new DeclarationRegistrationOptions return value for the corresponding server capability as well.

property linkSupport

linkSupport?: boolean;

The client supports additional metadata in the form of declaration links.

interface DeclarationOptions

interface DeclarationOptions extends WorkDoneProgressOptions {}

interface DeclarationParams

interface DeclarationParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

interface DeclarationRegistrationOptions

interface DeclarationRegistrationOptions
    extends DeclarationOptions,
        TextDocumentRegistrationOptions,
        StaticRegistrationOptions {}

interface DefinitionClientCapabilities

interface DefinitionClientCapabilities {}

Client Capabilities for a DefinitionRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether definition supports dynamic registration.

property linkSupport

linkSupport?: boolean;

The client supports additional metadata in the form of definition links.
3.14.0

interface DefinitionOptions

interface DefinitionOptions extends WorkDoneProgressOptions {}

Server Capabilities for a DefinitionRequest.

interface DefinitionParams

interface DefinitionParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

Parameters for a DefinitionRequest.

interface DefinitionRegistrationOptions

interface DefinitionRegistrationOptions
    extends TextDocumentRegistrationOptions,
        DefinitionOptions {}

Registration options for a DefinitionRequest.

interface DeleteFilesParams

interface DeleteFilesParams {}

The parameters sent in notifications/requests for user-initiated deletes of files.
3.16.0

property files

files: FileDelete[];

An array of all files/folders deleted in this operation.

interface DidChangeConfigurationClientCapabilities

interface DidChangeConfigurationClientCapabilities {}

property dynamicRegistration

dynamicRegistration?: boolean;

Did change configuration notification supports dynamic registration.

interface DidChangeConfigurationParams

interface DidChangeConfigurationParams {}

The parameters of a change configuration notification.

property settings

settings: LSPAny;

The actual changed settings

interface DidChangeConfigurationRegistrationOptions

interface DidChangeConfigurationRegistrationOptions {}

property section

section?: string | string[];

interface DidChangeTextDocumentParams

interface DidChangeTextDocumentParams {}

The change text document notification's parameters.

property contentChanges

contentChanges: TextDocumentContentChangeEvent[];

The actual content changes. The content changes describe single state changes to the document. So if there are two content changes c1 (at array index 0) and c2 (at array index 1) for a document in state S then c1 moves the document from S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed on the state S'.
To mirror the content of a document using change events use the following approach: - start with the same initial content - apply the 'textDocument/didChange' notifications in the order you receive them. - apply the TextDocumentContentChangeEvents in a single notification in the order you receive them.

property textDocument

textDocument: VersionedTextDocumentIdentifier;

The document that did change. The version number points to the version after all provided content changes have been applied.

interface DidChangeWatchedFilesClientCapabilities

interface DidChangeWatchedFilesClientCapabilities {}

property dynamicRegistration

dynamicRegistration?: boolean;

Did change watched files notification supports dynamic registration. Please note that the current protocol doesn't support static configuration for file changes from the server side.

property relativePatternSupport

relativePatternSupport?: boolean;

Whether the client has support for or not.
3.17.0

interface DidChangeWatchedFilesParams

interface DidChangeWatchedFilesParams {}

The watched files change notification's parameters.

property changes

changes: FileEvent[];

The actual file events.

interface DidChangeWatchedFilesRegistrationOptions

interface DidChangeWatchedFilesRegistrationOptions {}

Describe options to be used when registered for text document change events.

property watchers

watchers: FileSystemWatcher[];

The watchers to register.

interface DidChangeWorkspaceFoldersParams

interface DidChangeWorkspaceFoldersParams {}

The parameters of a workspace/didChangeWorkspaceFolders notification.

property event

event: WorkspaceFoldersChangeEvent;

The actual workspace folder change event.

interface DidCloseTextDocumentParams

interface DidCloseTextDocumentParams {}

The parameters sent in a close text document notification

property textDocument

textDocument: TextDocumentIdentifier;

The document that was closed.

interface DidOpenTextDocumentParams

interface DidOpenTextDocumentParams {}

The parameters sent in an open text document notification

property textDocument

textDocument: TextDocumentItem;

The document that was opened.

interface DidSaveTextDocumentParams

interface DidSaveTextDocumentParams {}

The parameters sent in a save text document notification

property text

text?: string;

Optional the content when saved. Depends on the includeText value when the save notification was requested.

property textDocument

textDocument: TextDocumentIdentifier;

The document that was saved.

interface DocumentColorOptions

interface DocumentColorOptions extends WorkDoneProgressOptions {}

interface DocumentColorParams

interface DocumentColorParams extends WorkDoneProgressParams, PartialResultParams {}

Parameters for a DocumentColorRequest.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface DocumentColorRegistrationOptions

interface DocumentColorRegistrationOptions
    extends TextDocumentRegistrationOptions,
        StaticRegistrationOptions,
        DocumentColorOptions {}

interface DocumentFormattingClientCapabilities

interface DocumentFormattingClientCapabilities {}

Client capabilities of a DocumentFormattingRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether formatting supports dynamic registration.

interface DocumentFormattingOptions

interface DocumentFormattingOptions extends WorkDoneProgressOptions {}

Provider options for a DocumentFormattingRequest.

interface DocumentFormattingParams

interface DocumentFormattingParams extends WorkDoneProgressParams {}

The parameters of a DocumentFormattingRequest.

property options

options: FormattingOptions;

The format options.

property textDocument

textDocument: TextDocumentIdentifier;

The document to format.

interface DocumentFormattingRegistrationOptions

interface DocumentFormattingRegistrationOptions
    extends TextDocumentRegistrationOptions,
        DocumentFormattingOptions {}

Registration options for a DocumentFormattingRequest.

interface DocumentHighlightClientCapabilities

interface DocumentHighlightClientCapabilities {}

Client Capabilities for a DocumentHighlightRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether document highlight supports dynamic registration.

interface DocumentHighlightOptions

interface DocumentHighlightOptions extends WorkDoneProgressOptions {}

Provider options for a DocumentHighlightRequest.

interface DocumentHighlightParams

interface DocumentHighlightParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

Parameters for a DocumentHighlightRequest.

interface DocumentHighlightRegistrationOptions

interface DocumentHighlightRegistrationOptions
    extends TextDocumentRegistrationOptions,
        DocumentHighlightOptions {}

Registration options for a DocumentHighlightRequest.

interface DocumentLinkClientCapabilities

interface DocumentLinkClientCapabilities {}

The client capabilities of a DocumentLinkRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether document link supports dynamic registration.

property tooltipSupport

tooltipSupport?: boolean;

Whether the client supports the tooltip property on DocumentLink.
3.15.0

interface DocumentLinkOptions

interface DocumentLinkOptions extends WorkDoneProgressOptions {}

Provider options for a DocumentLinkRequest.

property resolveProvider

resolveProvider?: boolean;

Document links have a resolve provider as well.

interface DocumentLinkParams

interface DocumentLinkParams extends WorkDoneProgressParams, PartialResultParams {}

The parameters of a DocumentLinkRequest.

property textDocument

textDocument: TextDocumentIdentifier;

The document to provide document links for.

interface DocumentLinkRegistrationOptions

interface DocumentLinkRegistrationOptions
    extends TextDocumentRegistrationOptions,
        DocumentLinkOptions {}

Registration options for a DocumentLinkRequest.

interface DocumentOnTypeFormattingClientCapabilities

interface DocumentOnTypeFormattingClientCapabilities {}

Client capabilities of a DocumentOnTypeFormattingRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether on type formatting supports dynamic registration.

interface DocumentOnTypeFormattingOptions

interface DocumentOnTypeFormattingOptions {}

Provider options for a DocumentOnTypeFormattingRequest.

property firstTriggerCharacter

firstTriggerCharacter: string;

A character on which formatting should be triggered, like {.

property moreTriggerCharacter

moreTriggerCharacter?: string[];

More trigger characters.

interface DocumentOnTypeFormattingParams

interface DocumentOnTypeFormattingParams {}

The parameters of a DocumentOnTypeFormattingRequest.

property ch

ch: string;

The character that has been typed that triggered the formatting on type request. That is not necessarily the last character that got inserted into the document since the client could auto insert characters as well (e.g. like automatic brace completion).

property options

options: FormattingOptions;

The formatting options.

property position

position: Position;

The position around which the on type formatting should happen. This is not necessarily the exact position where the character denoted by the property ch got typed.

property textDocument

textDocument: TextDocumentIdentifier;

The document to format.

interface DocumentOnTypeFormattingRegistrationOptions

interface DocumentOnTypeFormattingRegistrationOptions
    extends TextDocumentRegistrationOptions,
        DocumentOnTypeFormattingOptions {}

Registration options for a DocumentOnTypeFormattingRequest.

interface DocumentRangeFormattingClientCapabilities

interface DocumentRangeFormattingClientCapabilities {}

Client capabilities of a DocumentRangeFormattingRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether range formatting supports dynamic registration.

property rangesSupport

rangesSupport?: boolean;

Whether the client supports formatting multiple ranges at once.
3.18.0

interface DocumentRangeFormattingOptions

interface DocumentRangeFormattingOptions extends WorkDoneProgressOptions {}

Provider options for a DocumentRangeFormattingRequest.

property rangesSupport

rangesSupport?: boolean;

Whether the server supports formatting multiple ranges at once.
3.18.0

interface DocumentRangeFormattingParams

interface DocumentRangeFormattingParams extends WorkDoneProgressParams {}

The parameters of a DocumentRangeFormattingRequest.

property options

options: FormattingOptions;

The format options

property range

range: Range;

The range to format

property textDocument

textDocument: TextDocumentIdentifier;

The document to format.

interface DocumentRangeFormattingRegistrationOptions

interface DocumentRangeFormattingRegistrationOptions
    extends TextDocumentRegistrationOptions,
        DocumentRangeFormattingOptions {}

Registration options for a DocumentRangeFormattingRequest.

interface DocumentRangesFormattingParams

interface DocumentRangesFormattingParams extends WorkDoneProgressParams {}

The parameters of a DocumentRangesFormattingRequest.
3.18.0

property options

options: FormattingOptions;

The format options

property ranges

ranges: Range[];

The ranges to format

property textDocument

textDocument: TextDocumentIdentifier;

The document to format.

interface DocumentSymbolClientCapabilities

interface DocumentSymbolClientCapabilities {}

Client Capabilities for a DocumentSymbolRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether document symbol supports dynamic registration.

property hierarchicalDocumentSymbolSupport

hierarchicalDocumentSymbolSupport?: boolean;

The client supports hierarchical document symbols.

property labelSupport

labelSupport?: boolean;

The client supports an additional label presented in the UI when registering a document symbol provider.
3.16.0

property symbolKind

symbolKind?: {
    /**
     * The symbol kind values the client supports. When this
     * property exists the client also guarantees that it will
     * handle values outside its set gracefully and falls back
     * to a default value when unknown.
     *
     * If this property is not present the client only supports
     * the symbol kinds from `File` to `Array` as defined in
     * the initial version of the protocol.
     */
    valueSet?: SymbolKind[];
};

Specific capabilities for the SymbolKind in the textDocument/documentSymbol request.

property tagSupport

tagSupport?: {
    /**
     * The tags supported by the client.
     */
    valueSet: SymbolTag[];
};

The client supports tags on SymbolInformation. Tags are supported on DocumentSymbol if hierarchicalDocumentSymbolSupport is set to true. Clients supporting tags have to handle unknown tags gracefully.
3.16.0

interface DocumentSymbolOptions

interface DocumentSymbolOptions extends WorkDoneProgressOptions {}

Provider options for a DocumentSymbolRequest.

property label

label?: string;

A human-readable string that is shown when multiple outlines trees are shown for the same document.
3.16.0

interface DocumentSymbolParams

interface DocumentSymbolParams extends WorkDoneProgressParams, PartialResultParams {}

Parameters for a DocumentSymbolRequest.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface DocumentSymbolRegistrationOptions

interface DocumentSymbolRegistrationOptions
    extends TextDocumentRegistrationOptions,
        DocumentSymbolOptions {}

Registration options for a DocumentSymbolRequest.

interface ExecuteCommandClientCapabilities

interface ExecuteCommandClientCapabilities {}

The client capabilities of a ExecuteCommandRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Execute command supports dynamic registration.

interface ExecuteCommandOptions

interface ExecuteCommandOptions extends WorkDoneProgressOptions {}

The server capabilities of a ExecuteCommandRequest.

property commands

commands: string[];

The commands to be executed on the server

interface ExecuteCommandParams

interface ExecuteCommandParams extends WorkDoneProgressParams {}

The parameters of a ExecuteCommandRequest.

property arguments

arguments?: LSPAny[];

Arguments that the command should be invoked with.

property command

command: string;

The identifier of the actual command handler.

interface ExecuteCommandRegistrationOptions

interface ExecuteCommandRegistrationOptions extends ExecuteCommandOptions {}

Registration options for a ExecuteCommandRequest.

interface FileCreate

interface FileCreate {}

Represents information on a file/folder create.
3.16.0

property uri

uri: string;

A file:// URI for the location of the file/folder being created.

interface FileDelete

interface FileDelete {}

Represents information on a file/folder delete.
3.16.0

property uri

uri: string;

A file:// URI for the location of the file/folder being deleted.

interface FileEvent

interface FileEvent {}

An event describing a file change.

property type

type: FileChangeType;

The change type.

property uri

uri: DocumentUri;

The file's uri.

interface FileOperationClientCapabilities

interface FileOperationClientCapabilities {}

Capabilities relating to events from file operations by the user in the client.
These events do not come from the file system, they come from user operations like renaming a file in the UI.
3.16.0

property didCreate

didCreate?: boolean;

The client has support for sending didCreateFiles notifications.

property didDelete

didDelete?: boolean;

The client has support for sending didDeleteFiles notifications.

property didRename

didRename?: boolean;

The client has support for sending didRenameFiles notifications.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether the client supports dynamic registration for file requests/notifications.

property willCreate

willCreate?: boolean;

The client has support for sending willCreateFiles requests.

property willDelete

willDelete?: boolean;

The client has support for sending willDeleteFiles requests.

property willRename

willRename?: boolean;

The client has support for sending willRenameFiles requests.

interface FileOperationOptions

interface FileOperationOptions {}

Options for notifications/requests for user operations on files.
3.16.0

property didCreate

didCreate?: FileOperationRegistrationOptions;

The server is interested in receiving didCreateFiles notifications.

property didDelete

didDelete?: FileOperationRegistrationOptions;

The server is interested in receiving didDeleteFiles file notifications.

property didRename

didRename?: FileOperationRegistrationOptions;

The server is interested in receiving didRenameFiles notifications.

property willCreate

willCreate?: FileOperationRegistrationOptions;

The server is interested in receiving willCreateFiles requests.

property willDelete

willDelete?: FileOperationRegistrationOptions;

The server is interested in receiving willDeleteFiles file requests.

property willRename

willRename?: FileOperationRegistrationOptions;

The server is interested in receiving willRenameFiles requests.

interface FileOperationPatternOptions

interface FileOperationPatternOptions {}

Matching options for the file operation pattern.
3.16.0

property ignoreCase

ignoreCase?: boolean;

The pattern should be matched ignoring casing.

interface FileOperationRegistrationOptions

interface FileOperationRegistrationOptions {}

The options to register for file operations.
3.16.0

property filters

filters: FileOperationFilter[];

The actual filters.

interface FileRename

interface FileRename {}

Represents information on a file/folder rename.
3.16.0

property newUri

newUri: string;

A file:// URI for the new location of the file/folder being renamed.

property oldUri

oldUri: string;

A file:// URI for the original location of the file/folder being renamed.

interface FileSystemWatcher

interface FileSystemWatcher {}

property globPattern

globPattern: GlobPattern;

The glob pattern to watch. See for more detail.
3.17.0 support for relative patterns.

property kind

kind?: WatchKind;

The kind of events of interest. If omitted it defaults to WatchKind.Create | WatchKind.Change | WatchKind.Delete which is 7.

interface FoldingRangeClientCapabilities

interface FoldingRangeClientCapabilities {}

property dynamicRegistration

dynamicRegistration?: boolean;

Whether implementation supports dynamic registration for folding range providers. If this is set to true the client supports the new FoldingRangeRegistrationOptions return value for the corresponding server capability as well.

property foldingRange

foldingRange?: {
    /**
     * If set, the client signals that it supports setting collapsedText on
     * folding ranges to display custom labels instead of the default text.
     *
     * @since 3.17.0
     */
    collapsedText?: boolean;
};

Specific options for the folding range.
3.17.0

property foldingRangeKind

foldingRangeKind?: {
    /**
     * The folding range kind values the client supports. When this
     * property exists the client also guarantees that it will
     * handle values outside its set gracefully and falls back
     * to a default value when unknown.
     */
    valueSet?: FoldingRangeKind[];
};

Specific options for the folding range kind.
3.17.0

property lineFoldingOnly

lineFoldingOnly?: boolean;

If set, the client signals that it only supports folding complete lines. If set, client will ignore specified startCharacter and endCharacter properties in a FoldingRange.

property rangeLimit

rangeLimit?: uinteger;

The maximum number of folding ranges that the client prefers to receive per document. The value serves as a hint, servers are free to follow the limit.

interface FoldingRangeOptions

interface FoldingRangeOptions extends WorkDoneProgressOptions {}

interface FoldingRangeParams

interface FoldingRangeParams extends WorkDoneProgressParams, PartialResultParams {}

Parameters for a FoldingRangeRequest.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface FoldingRangeProviderOptions

interface FoldingRangeOptions extends WorkDoneProgressOptions {}

interface FoldingRangeRegistrationOptions

interface FoldingRangeRegistrationOptions
    extends TextDocumentRegistrationOptions,
        FoldingRangeOptions,
        StaticRegistrationOptions {}

interface GeneralClientCapabilities

interface GeneralClientCapabilities {}

General client capabilities.
3.16.0

property markdown

markdown?: MarkdownClientCapabilities;

Client capabilities specific to the client's markdown parser.
3.16.0

property positionEncodings

positionEncodings?: PositionEncodingKind[];

The position encodings supported by the client. Client and server have to agree on the same position encoding to ensure that offsets (e.g. character position in a line) are interpreted the same on both sides.
To keep the protocol backwards compatible the following applies: if the value 'utf-16' is missing from the array of position encodings servers can assume that the client supports UTF-16. UTF-16 is therefore a mandatory encoding.
If omitted it defaults to ['utf-16'].
Implementation considerations: since the conversion from one encoding into another requires the content of the file / line the conversion is best done where the file is read which is usually on the server side.
3.17.0

property regularExpressions

regularExpressions?: RegularExpressionsClientCapabilities;

Client capabilities specific to regular expressions.
3.16.0

property staleRequestSupport

staleRequestSupport?: {
    /**
     * The client will actively cancel the request.
     */
    cancel: boolean;
    /**
     * The list of requests for which the client
     * will retry the request if it receives a
     * response with error code `ContentModified`
     */
    retryOnContentModified: string[];
};

Client capability that signals how the client handles stale requests (e.g. a request for which the client will not process the response anymore since the information is outdated).
3.17.0

interface HoverClientCapabilities

interface HoverClientCapabilities {}

property contentFormat

contentFormat?: MarkupKind[];

Client supports the following content formats for the content property. The order describes the preferred format of the client.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether hover supports dynamic registration.

interface HoverOptions

interface HoverOptions extends WorkDoneProgressOptions {}

Hover options.

interface HoverParams

interface HoverParams extends TextDocumentPositionParams, WorkDoneProgressParams {}

Parameters for a HoverRequest.

interface HoverRegistrationOptions

interface HoverRegistrationOptions
    extends TextDocumentRegistrationOptions,
        HoverOptions {}

Registration options for a HoverRequest.

interface ImplementationOptions

interface ImplementationOptions extends WorkDoneProgressOptions {}

interface ImplementationParams

interface ImplementationParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

interface ImplementationRegistrationOptions

interface ImplementationRegistrationOptions
    extends TextDocumentRegistrationOptions,
        ImplementationOptions,
        StaticRegistrationOptions {}

interface InitializedParams

interface InitializedParams {}

interface InitializeError

interface InitializeError {}

The data type of the ResponseError if the initialize request fails.

property retry

retry: boolean;

Indicates whether the client execute the following retry logic: (1) show the message provided by the ResponseError to the user (2) user selects retry or cancel (3) if user selected retry the initialize method is sent again.

interface InitializeResult

interface InitializeResult<T = any> {}

The result returned from an initialize request.

property capabilities

capabilities: ServerCapabilities<T>;

The capabilities the language server provides.

property serverInfo

serverInfo?: {
    /**
     * The name of the server as defined by the server.
     */
    name: string;
    /**
     * The server's version as defined by the server.
     */
    version?: string;
};

Information about the server.
3.15.0

index signature

[custom: string]: LSPAny | ServerCapabilities<T> | undefined;

Custom initialization results.

interface LinkedEditingRangeClientCapabilities

interface LinkedEditingRangeClientCapabilities {}

Client capabilities for the linked editing range request.
3.16.0

property dynamicRegistration

dynamicRegistration?: boolean;

Whether implementation supports dynamic registration. If this is set to true the client supports the new (TextDocumentRegistrationOptions & StaticRegistrationOptions) return value for the corresponding server capability as well.

interface LinkedEditingRangeOptions

interface LinkedEditingRangeOptions extends WorkDoneProgressOptions {}

interface LinkedEditingRangeParams

interface LinkedEditingRangeParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams {}

interface LinkedEditingRangeRegistrationOptions

interface LinkedEditingRangeRegistrationOptions
    extends TextDocumentRegistrationOptions,
        LinkedEditingRangeOptions,
        StaticRegistrationOptions {}

interface LinkedEditingRanges

interface LinkedEditingRanges {}

The result of a linked editing range request.
3.16.0

property ranges

ranges: Range[];

A list of ranges that can be edited together. The ranges must have identical length and contain identical text content. The ranges cannot overlap.

property wordPattern

wordPattern?: string;

An optional word pattern (regular expression) that describes valid contents for the given ranges. If no pattern is provided, the client configuration's word pattern will be used.

interface LogMessageParams

interface LogMessageParams {}

The log message parameters.

property message

message: string;

The actual message.

property type

type: MessageType;

The message type. See MessageType

interface MarkdownClientCapabilities

interface MarkdownClientCapabilities {}

Client capabilities specific to the used markdown parser.
3.16.0

property allowedTags

allowedTags?: string[];

A list of HTML tags that the client allows / supports in Markdown.
3.17.0

property parser

parser: string;

The name of the parser.

property version

version?: string;

The version of the parser.

interface MessageActionItem

interface MessageActionItem {}

property title

title: string;

A short title like 'Retry', 'Open Log' etc.

index signature

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

Additional attributes that the client preserves and sends back to the server. This depends on the client capability window.messageActionItem.additionalPropertiesSupport

interface Moniker

interface Moniker {}

Moniker definition to match LSIF 0.5 moniker definition.
3.16.0

property identifier

identifier: string;

The identifier of the moniker. The value is opaque in LSIF however schema owners are allowed to define the structure if they want.

property kind

kind?: MonikerKind;

The moniker kind if known.

property scheme

scheme: string;

The scheme of the moniker. For example tsc or .Net

property unique

unique: UniquenessLevel;

The scope in which the moniker is unique

interface MonikerClientCapabilities

interface MonikerClientCapabilities {}

Client capabilities specific to the moniker request.
3.16.0

property dynamicRegistration

dynamicRegistration?: boolean;

Whether moniker supports dynamic registration. If this is set to true the client supports the new MonikerRegistrationOptions return value for the corresponding server capability as well.

interface MonikerOptions

interface MonikerOptions extends WorkDoneProgressOptions {}

interface MonikerParams

interface MonikerParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

interface MonikerRegistrationOptions

interface MonikerRegistrationOptions
    extends TextDocumentRegistrationOptions,
        MonikerOptions {}

interface NotebookDocumentClientCapabilities

interface NotebookDocumentClientCapabilities {}

Capabilities specific to the notebook document support.
3.17.0

property synchronization

synchronization: NotebookDocumentSyncClientCapabilities;

Capabilities specific to notebook document synchronization
3.17.0

interface PartialResultParams

interface PartialResultParams {}

property partialResultToken

partialResultToken?: ProgressToken;

An optional token that a server can use to report partial results (e.g. streaming) to the client.

interface PrepareRenameParams

interface PrepareRenameParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams {}

interface ProtocolConnection

interface ProtocolConnection {}

property onClose

onClose: Event<void>;

An event emitter firing when the connection got closed.

property onDispose

onDispose: Event<void>;

An event emitter firing when the connection got disposed.

property onError

onError: Event<[Error, Message | undefined, number | undefined]>;

An event emitter firing when an error occurs on the connection.

property onUnhandledNotification

onUnhandledNotification: Event<NotificationMessage>;

An event emitter firing when the connection receives a notification that is not handled.

method dispose

dispose: () => void;

Actively disposes the connection.

method end

end: () => void;

Ends the connection.

method hasPendingResponse

hasPendingResponse: () => boolean;

Returns true if the connection has a pending response. Otherwise false is returned.

method listen

listen: () => void;

Turns the connection into listening mode

method onNotification

onNotification: {
    <RO>(
        type: ProtocolNotificationType0<RO>,
        handler: NotificationHandler0
    ): Disposable;
    (type: NotificationType0, handler: NotificationHandler0): Disposable;
    <P, RO>(
        type: ProtocolNotificationType<P, RO>,
        handler: NotificationHandler<P>
    ): Disposable;
    <P>(type: NotificationType<P>, handler: NotificationHandler<P>): Disposable;
    (method: string, handler: GenericNotificationHandler): Disposable;
};

Installs a notification handler.
Parameter type
The notification type to install the handler for.
Parameter handler
The actual handler.
Returns
A disposable to remove the handler.
Installs a notification handler.
Parameter methods
The message method name to install the handler for.
Parameter handler
The actual handler.
Returns
A disposable to remove the handler.

method onProgress

onProgress: <P>(
    type: ProgressType<P>,
    token: string | number,
    handler: NotificationHandler<P>
) => Disposable;

Installs a progress handler for a given token.
Parameter type
the progress type
Parameter token
the token
Parameter handler
the handler
Returns
A disposable to remove the handler.

method onRequest

onRequest: {
    <R, PR, E, RO>(
        type: ProtocolRequestType0<R, PR, E, RO>,
        handler: RequestHandler0<R, E>
    ): Disposable;
    <R, E>(type: RequestType0<R, E>, handler: RequestHandler0<R, E>): Disposable;
    <P, R, PR, E, RO>(
        type: ProtocolRequestType<P, R, PR, E, RO>,
        handler: RequestHandler<P, R, E>
    ): Disposable;
    <P, R, E>(
        type: RequestType<P, R, E>,
        handler: RequestHandler<P, R, E>
    ): Disposable;
    <R, E>(method: string, handler: GenericRequestHandler<R, E>): Disposable;
};

Installs a request handler.
Parameter type
The request type to install the handler for.
Parameter handler
The actual handler.
Returns
A disposable to remove the handler.
Installs a request handler.
Parameter methods
the message method name to install a handler for.
Parameter handler
The actual handler.
Returns
A disposable to remove the handler.

method sendNotification

sendNotification: {
    (type: NotificationType0): Promise<void>;
    <RO>(type: ProtocolNotificationType0<RO>): Promise<void>;
    <P, RO>(type: ProtocolNotificationType<P, RO>, params?: P): Promise<void>;
    <P>(type: NotificationType<P>, params?: P): Promise<void>;
    (method: string): Promise<void>;
    (method: string, params: any): Promise<void>;
};

Sends a notification.
Parameter type
the notification's type to send.
Returns
A promise that resolves when the notification is written to the network layer.
Sends a notification.
Parameter type
the notification's type to send.
Parameter params
the notification's parameters.
Returns
A promise that resolves when the notification is written to the network layer.
Sends a notification.
Parameter method
the notification's method name.
Returns
A promise that resolves when the notification is written to the network layer.
Sends a notification.
Parameter method
the notification's method name.
Parameter params
the notification's parameters.
Returns
A promise that resolves when the notification is written to the network layer.

method sendProgress

sendProgress: <P>(
    type: ProgressType<P>,
    token: string | number,
    value: P
) => Promise<void>;

Sends progress.
Parameter type
the progress type
Parameter token
the token to use
Parameter value
the progress value
Returns
A promise that resolves when the progress is written to the network layer.

method sendRequest

sendRequest: {
    <R, PR, E, RO>(
        type: ProtocolRequestType0<R, PR, E, RO>,
        token?: CancellationToken
    ): Promise<R>;
    <R, E>(type: RequestType0<R, E>, token?: CancellationToken): Promise<R>;
    <P, R, PR, E, RO>(
        type: ProtocolRequestType<P, R, PR, E, RO>,
        params: P,
        token?: CancellationToken
    ): Promise<R>;
    <P, R, E>(
        type: RequestType<P, R, E>,
        params: P,
        token?: CancellationToken
    ): Promise<R>;
    <R>(method: string, token?: CancellationToken): Promise<R>;
    <R>(method: string, param: any, token?: CancellationToken): Promise<R>;
};

Sends a request and returns a promise resolving to the result of the request.
Parameter type
The type of request to sent.
Parameter token
An optional cancellation token.
Returns
A promise resolving to the request's result.
Sends a request and returns a promise resolving to the result of the request.
Parameter type
The type of request to sent.
Parameter params
The request's parameter.
Parameter token
An optional cancellation token.
Returns
A promise resolving to the request's result.
Sends a request and returns a promise resolving to the result of the request.
Parameter method
the method name.
Parameter token
An optional cancellation token.
Returns
A promise resolving to the request's result.
Sends a request and returns a promise resolving to the result of the request.
Parameter method
the method name.
Parameter params
The request's parameter.
Parameter token
An optional cancellation token.
Returns
A promise resolving to the request's result.

method trace

trace: {
    (value: Trace, tracer: Tracer, sendNotification?: boolean): Promise<void>;
    (value: Trace, tracer: Tracer, traceOptions?: TraceOptions): Promise<void>;
};

Enables tracing mode for the connection.
Returns
A promise that resolves when the trace value is written to the network layer.

interface PublishDiagnosticsClientCapabilities

interface PublishDiagnosticsClientCapabilities {}

The publish diagnostic client capabilities.

property codeDescriptionSupport

codeDescriptionSupport?: boolean;

Client supports a codeDescription property
3.16.0

property dataSupport

dataSupport?: boolean;

Whether code action supports the data property which is preserved between a textDocument/publishDiagnostics and textDocument/codeAction request.
3.16.0

property relatedInformation

relatedInformation?: boolean;

Whether the clients accepts diagnostics with related information.

property tagSupport

tagSupport?: {
    /**
     * The tags supported by the client.
     */
    valueSet: DiagnosticTag[];
};

Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully.
3.15.0

property versionSupport

versionSupport?: boolean;

Whether the client interprets the version property of the textDocument/publishDiagnostics notification's parameter.
3.15.0

interface PublishDiagnosticsParams

interface PublishDiagnosticsParams {}

The publish diagnostic notification's parameters.

property diagnostics

diagnostics: Diagnostic[];

An array of diagnostic information items.

property uri

uri: DocumentUri;

The URI for which diagnostic information is reported.

property version

version?: integer;

Optional the version number of the document the diagnostics are published for.
3.15.0

interface ReferenceClientCapabilities

interface ReferenceClientCapabilities {}

Client Capabilities for a ReferencesRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether references supports dynamic registration.

interface ReferenceOptions

interface ReferenceOptions extends WorkDoneProgressOptions {}

Reference options.

interface ReferenceParams

interface ReferenceParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

Parameters for a ReferencesRequest.

property context

context: ReferenceContext;

interface ReferenceRegistrationOptions

interface ReferenceRegistrationOptions
    extends TextDocumentRegistrationOptions,
        ReferenceOptions {}

Registration options for a ReferencesRequest.

interface Registration

interface Registration {}

General parameters to register for a notification or to register a provider.

property id

id: string;

The id used to register the request. The id can be used to deregister the request again.

property method

method: string;

The method / capability to register for.

property registerOptions

registerOptions?: LSPAny;

Options necessary for the registration.

interface RegistrationParams

interface RegistrationParams {}

property registrations

registrations: Registration[];

interface RegularExpressionsClientCapabilities

interface RegularExpressionsClientCapabilities {}

Client capabilities specific to regular expressions.
3.16.0

property engine

engine: string;

The engine's name.

property version

version?: string;

The engine's version.

interface RelativePattern

interface RelativePattern {}

A relative pattern is a helper to construct glob patterns that are matched relatively to a base URI. The common value for a baseUri is a workspace folder root, but it can be another absolute URI as well.
3.17.0

property baseUri

baseUri: WorkspaceFolder | URI;

A workspace folder or a base URI to which this pattern will be matched against relatively.

property pattern

pattern: Pattern;

The actual glob pattern;

interface RenameClientCapabilities

interface RenameClientCapabilities {}

property dynamicRegistration

dynamicRegistration?: boolean;

Whether rename supports dynamic registration.

property honorsChangeAnnotations

honorsChangeAnnotations?: boolean;

Whether the client honors the change annotations in text edits and resource operations returned via the rename request's workspace edit by for example presenting the workspace edit in the user interface and asking for confirmation.
3.16.0

property prepareSupport

prepareSupport?: boolean;

Client supports testing for validity of rename operations before execution.
3.12.0

property prepareSupportDefaultBehavior

prepareSupportDefaultBehavior?: PrepareSupportDefaultBehavior;

Client supports the default behavior result.
The value indicates the default behavior used by the client.
3.16.0

interface RenameFilesParams

interface RenameFilesParams {}

The parameters sent in notifications/requests for user-initiated renames of files.
3.16.0

property files

files: FileRename[];

An array of all files/folders renamed in this operation. When a folder is renamed, only the folder will be included, and not its children.

interface RenameOptions

interface RenameOptions extends WorkDoneProgressOptions {}

Provider options for a RenameRequest.

property prepareProvider

prepareProvider?: boolean;

Renames should be checked and tested before being executed.
version 3.12.0

interface RenameParams

interface RenameParams extends WorkDoneProgressParams {}

The parameters of a RenameRequest.

property newName

newName: string;

The new name of the symbol. If the given name is not valid the request must return a ResponseError with an appropriate message set.

property position

position: Position;

The position at which this request was sent.

property textDocument

textDocument: TextDocumentIdentifier;

The document to rename.

interface RenameRegistrationOptions

interface RenameRegistrationOptions
    extends TextDocumentRegistrationOptions,
        RenameOptions {}

Registration options for a RenameRequest.

interface SaveOptions

interface SaveOptions {}

Save options.

property includeText

includeText?: boolean;

The client is supposed to include the content on save.

interface SelectionRangeClientCapabilities

interface SelectionRangeClientCapabilities {}

property dynamicRegistration

dynamicRegistration?: boolean;

Whether implementation supports dynamic registration for selection range providers. If this is set to true the client supports the new SelectionRangeRegistrationOptions return value for the corresponding server capability as well.

interface SelectionRangeOptions

interface SelectionRangeOptions extends WorkDoneProgressOptions {}

interface SelectionRangeParams

interface SelectionRangeParams extends WorkDoneProgressParams, PartialResultParams {}

A parameter literal used in selection range requests.

property positions

positions: Position[];

The positions inside the text document.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface SelectionRangeProviderOptions

interface SelectionRangeOptions extends WorkDoneProgressOptions {}

interface SelectionRangeRegistrationOptions

interface SelectionRangeRegistrationOptions
    extends SelectionRangeOptions,
        TextDocumentRegistrationOptions,
        StaticRegistrationOptions {}

interface SemanticTokensClientCapabilities

interface SemanticTokensClientCapabilities {}

3.16.0

property augmentsSyntaxTokens

augmentsSyntaxTokens?: boolean;

Whether the client uses semantic tokens to augment existing syntax tokens. If set to true client side created syntax tokens and semantic tokens are both used for colorization. If set to false the client only uses the returned semantic tokens for colorization.
If the value is undefined then the client behavior is not specified.
3.17.0

property dynamicRegistration

dynamicRegistration?: boolean;

Whether implementation supports dynamic registration. If this is set to true the client supports the new (TextDocumentRegistrationOptions & StaticRegistrationOptions) return value for the corresponding server capability as well.

property formats

formats: TokenFormat[];

The token formats the clients supports.

property multilineTokenSupport

multilineTokenSupport?: boolean;

Whether the client supports tokens that can span multiple lines.

property overlappingTokenSupport

overlappingTokenSupport?: boolean;

Whether the client supports tokens that can overlap each other.

property requests

requests: {
    /**
     * The client will send the `textDocument/semanticTokens/range` request if
     * the server provides a corresponding handler.
     */
    range?: boolean | {};
    /**
     * The client will send the `textDocument/semanticTokens/full` request if
     * the server provides a corresponding handler.
     */
    full?:
        | boolean
        | {
              /**
               * The client will send the `textDocument/semanticTokens/full/delta` request if
               * the server provides a corresponding handler.
               */
              delta?: boolean;
          };
};

Which requests the client supports and might send to the server depending on the server's capability. Please note that clients might not show semantic tokens or degrade some of the user experience if a range or full request is advertised by the client but not provided by the server. If for example the client capability requests.full and request.range are both set to true but the server only provides a range provider the client might not render a minimap correctly or might even decide to not show any semantic tokens at all.

property serverCancelSupport

serverCancelSupport?: boolean;

Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning LSPErrorCodes.ServerCancelled. If a server does the client needs to retrigger the request.
3.17.0

property tokenModifiers

tokenModifiers: string[];

The token modifiers that the client supports.

property tokenTypes

tokenTypes: string[];

The token types that the client supports.

interface SemanticTokensDeltaParams

interface SemanticTokensDeltaParams
    extends WorkDoneProgressParams,
        PartialResultParams {}

3.16.0

property previousResultId

previousResultId: string;

The result id of a previous response. The result Id can either point to a full response or a delta response depending on what was received last.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface SemanticTokensDeltaPartialResult

interface SemanticTokensDeltaPartialResult {}

3.16.0

property edits

edits: SemanticTokensEdit[];

interface SemanticTokensOptions

interface SemanticTokensOptions extends WorkDoneProgressOptions {}

3.16.0

property full

full?:
    | boolean
    | {
          /**
           * The server supports deltas for full documents.
           */
          delta?: boolean;
      };

Server supports providing semantic tokens for a full document.

property legend

legend: SemanticTokensLegend;

The legend used by the server

property range

range?: boolean | {};

Server supports providing semantic tokens for a specific range of a document.

interface SemanticTokensParams

interface SemanticTokensParams extends WorkDoneProgressParams, PartialResultParams {}

3.16.0

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface SemanticTokensPartialResult

interface SemanticTokensPartialResult {}

3.16.0

property data

data: uinteger[];

interface SemanticTokensRangeParams

interface SemanticTokensRangeParams
    extends WorkDoneProgressParams,
        PartialResultParams {}

3.16.0

property range

range: Range;

The range the semantic tokens are requested for.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface SemanticTokensRegistrationOptions

interface SemanticTokensRegistrationOptions
    extends TextDocumentRegistrationOptions,
        SemanticTokensOptions,
        StaticRegistrationOptions {}

3.16.0

interface ServerCapabilities

interface ServerCapabilities<T = LSPAny> {}

Defines the capabilities provided by a language server.

property callHierarchyProvider

callHierarchyProvider?:
    | boolean
    | CallHierarchyOptions
    | CallHierarchyRegistrationOptions;

The server provides call hierarchy support.
3.16.0

property codeActionProvider

codeActionProvider?: boolean | CodeActionOptions;

The server provides code actions. CodeActionOptions may only be specified if the client states that it supports codeActionLiteralSupport in its initial initialize request.

property codeLensProvider

codeLensProvider?: CodeLensOptions;

The server provides code lens.

property colorProvider

colorProvider?:
    | boolean
    | DocumentColorOptions
    | DocumentColorRegistrationOptions;

The server provides color provider support.

property completionProvider

completionProvider?: CompletionOptions;

The server provides completion support.

property declarationProvider

declarationProvider?:
    | boolean
    | DeclarationOptions
    | DeclarationRegistrationOptions;

The server provides Goto Declaration support.

property definitionProvider

definitionProvider?: boolean | DefinitionOptions;

The server provides goto definition support.

property diagnosticProvider

diagnosticProvider?: DiagnosticOptions | DiagnosticRegistrationOptions;

The server has support for pull model diagnostics.
3.17.0

property documentFormattingProvider

documentFormattingProvider?: boolean | DocumentFormattingOptions;

The server provides document formatting.

property documentHighlightProvider

documentHighlightProvider?: boolean | DocumentHighlightOptions;

The server provides document highlight support.

property documentLinkProvider

documentLinkProvider?: DocumentLinkOptions;

The server provides document link support.

property documentOnTypeFormattingProvider

documentOnTypeFormattingProvider?: DocumentOnTypeFormattingOptions;

The server provides document formatting on typing.

property documentRangeFormattingProvider

documentRangeFormattingProvider?: boolean | DocumentRangeFormattingOptions;

The server provides document range formatting.

property documentSymbolProvider

documentSymbolProvider?: boolean | DocumentSymbolOptions;

The server provides document symbol support.

property executeCommandProvider

executeCommandProvider?: ExecuteCommandOptions;

The server provides execute command support.

property experimental

experimental?: T;

Experimental server capabilities.

property foldingRangeProvider

foldingRangeProvider?:
    | boolean
    | FoldingRangeOptions
    | FoldingRangeRegistrationOptions;

The server provides folding provider support.

property hoverProvider

hoverProvider?: boolean | HoverOptions;

The server provides hover support.

property implementationProvider

implementationProvider?:
    | boolean
    | ImplementationOptions
    | ImplementationRegistrationOptions;

The server provides Goto Implementation support.

property inlayHintProvider

inlayHintProvider?: boolean | InlayHintOptions | InlayHintRegistrationOptions;

The server provides inlay hints.
3.17.0

property inlineCompletionProvider

inlineCompletionProvider?: boolean | InlineCompletionOptions;

Inline completion options used during static registration.
3.18.0

property inlineValueProvider

inlineValueProvider?:
    | boolean
    | InlineValueOptions
    | InlineValueRegistrationOptions;

The server provides inline values.
3.17.0

property linkedEditingRangeProvider

linkedEditingRangeProvider?:
    | boolean
    | LinkedEditingRangeOptions
    | LinkedEditingRangeRegistrationOptions;

The server provides linked editing range support.
3.16.0

property monikerProvider

monikerProvider?: boolean | MonikerOptions | MonikerRegistrationOptions;

The server provides moniker support.
3.16.0

property notebookDocumentSync

notebookDocumentSync?:
    | NotebookDocumentSyncOptions
    | NotebookDocumentSyncRegistrationOptions;

Defines how notebook documents are synced.
3.17.0

property positionEncoding

positionEncoding?: PositionEncodingKind;

The position encoding the server picked from the encodings offered by the client via the client capability general.positionEncodings.
If the client didn't provide any position encodings the only valid value that a server can return is 'utf-16'.
If omitted it defaults to 'utf-16'.
3.17.0

property referencesProvider

referencesProvider?: boolean | ReferenceOptions;

The server provides find references support.

property renameProvider

renameProvider?: boolean | RenameOptions;

The server provides rename support. RenameOptions may only be specified if the client states that it supports prepareSupport in its initial initialize request.

property selectionRangeProvider

selectionRangeProvider?:
    | boolean
    | SelectionRangeOptions
    | SelectionRangeRegistrationOptions;

The server provides selection range support.

property semanticTokensProvider

semanticTokensProvider?:
    | SemanticTokensOptions
    | SemanticTokensRegistrationOptions;

The server provides semantic tokens support.
3.16.0

property signatureHelpProvider

signatureHelpProvider?: SignatureHelpOptions;

The server provides signature help support.

property textDocumentSync

textDocumentSync?: TextDocumentSyncOptions | TextDocumentSyncKind;

Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number.

property typeDefinitionProvider

typeDefinitionProvider?:
    | boolean
    | TypeDefinitionOptions
    | TypeDefinitionRegistrationOptions;

The server provides Goto Type Definition support.

property typeHierarchyProvider

typeHierarchyProvider?:
    | boolean
    | TypeHierarchyOptions
    | TypeHierarchyRegistrationOptions;

The server provides type hierarchy support.
3.17.0

property workspace

workspace?: {
    /**
     * The server supports workspace folder.
     *
     * @since 3.6.0
     */
    workspaceFolders?: WorkspaceFoldersServerCapabilities;
    /**
     * The server is interested in notifications/requests for operations on files.
     *
     * @since 3.16.0
     */
    fileOperations?: FileOperationOptions;
};

Workspace specific server capabilities.

property workspaceSymbolProvider

workspaceSymbolProvider?: boolean | WorkspaceSymbolOptions;

The server provides workspace symbol support.

interface ShowDocumentClientCapabilities

interface ShowDocumentClientCapabilities {}

Client capabilities for the showDocument request.
3.16.0

property support

support: boolean;

The client has support for the showDocument request.

interface ShowDocumentParams

interface ShowDocumentParams {}

Params to show a resource in the UI.
3.16.0

property external

external?: boolean;

Indicates to show the resource in an external program. To show, for example, https://code.visualstudio.com/ in the default WEB browser set external to true.

property selection

selection?: Range;

An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

property takeFocus

takeFocus?: boolean;

An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

property uri

uri: URI;

The uri to show.

interface ShowDocumentResult

interface ShowDocumentResult {}

The result of a showDocument request.
3.16.0

property success

success: boolean;

A boolean indicating if the show was successful.

interface ShowMessageParams

interface ShowMessageParams {}

The parameters of a notification message.

property message

message: string;

The actual message.

property type

type: MessageType;

The message type. See MessageType

interface ShowMessageRequestClientCapabilities

interface ShowMessageRequestClientCapabilities {}

Show message request client capabilities

property messageActionItem

messageActionItem?: {
    /**
     * Whether the client supports additional attributes which
     * are preserved and send back to the server in the
     * request's response.
     */
    additionalPropertiesSupport?: boolean;
};

Capabilities specific to the MessageActionItem type.

interface ShowMessageRequestParams

interface ShowMessageRequestParams {}

property actions

actions?: MessageActionItem[];

The message action items to present.

property message

message: string;

The actual message.

property type

type: MessageType;

The message type. See MessageType

interface SignatureHelpClientCapabilities

interface SignatureHelpClientCapabilities {}

Client Capabilities for a SignatureHelpRequest.

property contextSupport

contextSupport?: boolean;

The client supports to send additional context information for a textDocument/signatureHelp request. A client that opts into contextSupport will also support the retriggerCharacters on SignatureHelpOptions.
3.15.0

property dynamicRegistration

dynamicRegistration?: boolean;

Whether signature help supports dynamic registration.

property signatureInformation

signatureInformation?: {
    /**
     * Client supports the following content formats for the documentation
     * property. The order describes the preferred format of the client.
     */
    documentationFormat?: MarkupKind[];
    /**
     * Client capabilities specific to parameter information.
     */
    parameterInformation?: {
        /**
         * The client supports processing label offsets instead of a
         * simple label string.
         *
         * @since 3.14.0
         */
        labelOffsetSupport?: boolean;
    };
    /**
     * The client supports the `activeParameter` property on `SignatureInformation`
     * literal.
     *
     * @since 3.16.0
     */
    activeParameterSupport?: boolean;
};

The client supports the following SignatureInformation specific properties.

interface SignatureHelpContext

interface SignatureHelpContext {}

Additional information about the context in which a signature help request was triggered.
3.15.0

property activeSignatureHelp

activeSignatureHelp?: SignatureHelp;

The currently active SignatureHelp.
The activeSignatureHelp has its SignatureHelp.activeSignature field updated based on the user navigating through available signatures.

property isRetrigger

isRetrigger: boolean;

true if signature help was already showing when it was triggered.
Retriggers occurs when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

property triggerCharacter

triggerCharacter?: string;

Character that caused signature help to be triggered.
This is undefined when triggerKind !== SignatureHelpTriggerKind.TriggerCharacter

property triggerKind

triggerKind: SignatureHelpTriggerKind;

Action that c

vscode-languageserver-protocol

Install

Overview

Index

Functions

Classes

Interfaces

Enums

Type Aliases

Namespaces

Functions

function createProtocolConnection

Classes

class ProtocolNotificationType

constructor

class ProtocolNotificationType0

constructor

class ProtocolRequestType

constructor

class ProtocolRequestType0

constructor

class RegistrationType

constructor

property method

Interfaces

interface ApplyWorkspaceEditParams

property edit

property label

interface ApplyWorkspaceEditResult

property applied

property failedChange

property failureReason

interface CallHierarchyClientCapabilities

property dynamicRegistration

interface CallHierarchyIncomingCallsParams

property item

interface CallHierarchyOptions

interface CallHierarchyOutgoingCallsParams

property item

interface CallHierarchyPrepareParams

interface CallHierarchyRegistrationOptions

interface ClientCapabilities

property experimental

property general

property notebookDocument

property textDocument

property window

property workspace

interface CodeActionClientCapabilities

property codeActionLiteralSupport

property dataSupport

property disabledSupport

property dynamicRegistration

property honorsChangeAnnotations

property isPreferredSupport

property resolveSupport

interface CodeActionOptions

property codeActionKinds

property resolveProvider

interface CodeActionParams

property context

property range

property textDocument

interface CodeActionRegistrationOptions

interface CodeLensClientCapabilities

property dynamicRegistration

interface CodeLensOptions

property resolveProvider

interface CodeLensParams

property textDocument

interface CodeLensRegistrationOptions

interface CodeLensWorkspaceClientCapabilities

property refreshSupport

interface ColorOptions

interface ColorPresentationParams

property color

property range

property textDocument

interface ColorProviderOptions

interface ColorRegistrationOptions