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 caused signature help to be triggered.

interface SignatureHelpOptions

interface SignatureHelpOptions extends WorkDoneProgressOptions {}

Server Capabilities for a SignatureHelpRequest.

property retriggerCharacters

retriggerCharacters?: string[];

List of characters that re-trigger signature help.
These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.
3.15.0

property triggerCharacters

triggerCharacters?: string[];

List of characters that trigger signature help automatically.

interface SignatureHelpParams

interface SignatureHelpParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams {}

Parameters for a SignatureHelpRequest.

property context

context?: SignatureHelpContext;

The signature help context. This is only available if the client specifies to send this using the client capability textDocument.signatureHelp.contextSupport === true
3.15.0

interface SignatureHelpRegistrationOptions

interface SignatureHelpRegistrationOptions
    extends TextDocumentRegistrationOptions,
        SignatureHelpOptions {}

Registration options for a SignatureHelpRequest.

interface StaticRegistrationOptions

interface StaticRegistrationOptions {}

Static registration options to be returned in the initialize request.

property id

id?: string;

The id used to register the request. The id can be used to deregister the request again. See also Registration#id.

interface TextDocumentChangeRegistrationOptions

interface TextDocumentChangeRegistrationOptions
    extends TextDocumentRegistrationOptions {}

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

property syncKind

syncKind: TextDocumentSyncKind;

How documents are synced to the server.

interface TextDocumentClientCapabilities

interface TextDocumentClientCapabilities {}

Text document specific client capabilities.

property callHierarchy

callHierarchy?: CallHierarchyClientCapabilities;

Capabilities specific to the various call hierarchy requests.
3.16.0

property codeAction

codeAction?: CodeActionClientCapabilities;

Capabilities specific to the textDocument/codeAction request.

property codeLens

codeLens?: CodeLensClientCapabilities;

Capabilities specific to the textDocument/codeLens request.

property colorProvider

colorProvider?: DocumentColorClientCapabilities;

Capabilities specific to the textDocument/documentColor and the textDocument/colorPresentation request.
3.6.0

property completion

completion?: CompletionClientCapabilities;

Capabilities specific to the textDocument/completion request.

property declaration

declaration?: DeclarationClientCapabilities;

Capabilities specific to the textDocument/declaration request.
3.14.0

property definition

definition?: DefinitionClientCapabilities;

Capabilities specific to the textDocument/definition request.

property diagnostic

diagnostic?: DiagnosticClientCapabilities;

Capabilities specific to the diagnostic pull model.
3.17.0

property documentHighlight

documentHighlight?: DocumentHighlightClientCapabilities;

Capabilities specific to the textDocument/documentHighlight request.

property documentLink

documentLink?: DocumentLinkClientCapabilities;

Capabilities specific to the textDocument/documentLink request.

property documentSymbol

documentSymbol?: DocumentSymbolClientCapabilities;

Capabilities specific to the textDocument/documentSymbol request.

property foldingRange

foldingRange?: FoldingRangeClientCapabilities;

Capabilities specific to the textDocument/foldingRange request.
3.10.0

property formatting

formatting?: DocumentFormattingClientCapabilities;

Capabilities specific to the textDocument/formatting request.

property hover

hover?: HoverClientCapabilities;

Capabilities specific to the textDocument/hover request.

property implementation

implementation?: ImplementationClientCapabilities;

Capabilities specific to the textDocument/implementation request.
3.6.0

property inlayHint

inlayHint?: InlayHintClientCapabilities;

Capabilities specific to the textDocument/inlayHint request.
3.17.0

property inlineCompletion

inlineCompletion?: InlineCompletionClientCapabilities;

Client capabilities specific to inline completions.
3.18.0

property inlineValue

inlineValue?: InlineValueClientCapabilities;

Capabilities specific to the textDocument/inlineValue request.
3.17.0

property linkedEditingRange

linkedEditingRange?: LinkedEditingRangeClientCapabilities;

Capabilities specific to the textDocument/linkedEditingRange request.
3.16.0

property moniker

moniker?: MonikerClientCapabilities;

Client capabilities specific to the textDocument/moniker request.
3.16.0

property onTypeFormatting

onTypeFormatting?: DocumentOnTypeFormattingClientCapabilities;

Capabilities specific to the textDocument/onTypeFormatting request.

property publishDiagnostics

publishDiagnostics?: PublishDiagnosticsClientCapabilities;

Capabilities specific to the textDocument/publishDiagnostics notification.

property rangeFormatting

rangeFormatting?: DocumentRangeFormattingClientCapabilities;

Capabilities specific to the textDocument/rangeFormatting request.

property references

references?: ReferenceClientCapabilities;

Capabilities specific to the textDocument/references request.

property rename

rename?: RenameClientCapabilities;

Capabilities specific to the textDocument/rename request.

property selectionRange

selectionRange?: SelectionRangeClientCapabilities;

Capabilities specific to the textDocument/selectionRange request.
3.15.0

property semanticTokens

semanticTokens?: SemanticTokensClientCapabilities;

Capabilities specific to the various semantic token request.
3.16.0

property signatureHelp

signatureHelp?: SignatureHelpClientCapabilities;

Capabilities specific to the textDocument/signatureHelp request.

property synchronization

synchronization?: TextDocumentSyncClientCapabilities;

Defines which synchronization capabilities the client supports.

property typeDefinition

typeDefinition?: TypeDefinitionClientCapabilities;

Capabilities specific to the textDocument/typeDefinition request.
3.6.0

property typeHierarchy

typeHierarchy?: TypeHierarchyClientCapabilities;

Capabilities specific to the various type hierarchy requests.
3.17.0

interface TextDocumentPositionParams

interface TextDocumentPositionParams {}

A parameter literal used in requests to pass a text document and a position inside that document.

property position

position: Position;

The position inside the text document.

property textDocument

textDocument: TextDocumentIdentifier;

The text document.

interface TextDocumentRegistrationOptions

interface TextDocumentRegistrationOptions {}

General text document registration options.

property documentSelector

documentSelector: DocumentSelector | null;

A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.

interface TextDocumentSaveRegistrationOptions

interface TextDocumentSaveRegistrationOptions
    extends TextDocumentRegistrationOptions,
        SaveOptions {}

Save registration options.

interface TextDocumentSyncClientCapabilities

interface TextDocumentSyncClientCapabilities {}

property didSave

didSave?: boolean;

The client supports did save notifications.

property dynamicRegistration

dynamicRegistration?: boolean;

Whether text document synchronization supports dynamic registration.

property willSave

willSave?: boolean;

The client supports sending will save notifications.

property willSaveWaitUntil

willSaveWaitUntil?: boolean;

The client supports sending a will save request and waits for a response providing text edits which will be applied to the document before it is saved.

interface TextDocumentSyncOptions

interface TextDocumentSyncOptions {}

property change

change?: TextDocumentSyncKind;

Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.

property openClose

openClose?: boolean;

Open and close notifications are sent to the server. If omitted open close notification should not be sent.

property save

save?: boolean | SaveOptions;

If present save notifications are sent to the server. If omitted the notification should not be sent.

property willSave

willSave?: boolean;

If present will save notifications are sent to the server. If omitted the notification should not be sent.

property willSaveWaitUntil

willSaveWaitUntil?: boolean;

If present will save wait until requests are sent to the server. If omitted the request should not be sent.

interface TypeDefinitionOptions

interface TypeDefinitionOptions extends WorkDoneProgressOptions {}

interface TypeDefinitionParams

interface TypeDefinitionParams
    extends TextDocumentPositionParams,
        WorkDoneProgressParams,
        PartialResultParams {}

interface TypeDefinitionRegistrationOptions

interface TypeDefinitionRegistrationOptions
    extends TextDocumentRegistrationOptions,
        TypeDefinitionOptions,
        StaticRegistrationOptions {}

interface Unregistration

interface Unregistration {}

General parameters to unregister a request or notification.

property id

id: string;

The id used to unregister the request or notification. Usually an id provided during the register request.

property method

method: string;

The method to unregister for.

interface UnregistrationParams

interface UnregistrationParams {}

property unregisterations

unregisterations: Unregistration[];

interface WillSaveTextDocumentParams

interface WillSaveTextDocumentParams {}

The parameters sent in a will save text document notification.

property reason

reason: TextDocumentSaveReason;

The 'TextDocumentSaveReason'.

property textDocument

textDocument: TextDocumentIdentifier;

The document that will be saved.

interface WindowClientCapabilities

interface WindowClientCapabilities {}

property showDocument

showDocument?: ShowDocumentClientCapabilities;

Capabilities specific to the showDocument request.
3.16.0

property showMessage

showMessage?: ShowMessageRequestClientCapabilities;

Capabilities specific to the showMessage request.
3.16.0

property workDoneProgress

workDoneProgress?: boolean;

It indicates whether the client supports server initiated progress using the window/workDoneProgress/create request.
The capability also controls Whether client supports handling of progress notifications. If set servers are allowed to report a workDoneProgress property in the request specific server capabilities.
3.15.0

interface WorkDoneProgressBegin

interface WorkDoneProgressBegin {}

property cancellable

cancellable?: boolean;

Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don't support cancellation are allowed to ignore the setting.

property kind

kind: 'begin';

property message

message?: string;

Optional, more detailed associated progress message. Contains complementary information to the title.
Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.

property percentage

percentage?: uinteger;

Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the percentage value in subsequent in report notifications.
The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100].

property title

title: string;

Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.
Examples: "Indexing" or "Linking dependencies".

interface WorkDoneProgressCancelParams

interface WorkDoneProgressCancelParams {}

property token

token: ProgressToken;

The token to be used to report progress.

interface WorkDoneProgressCreateParams

interface WorkDoneProgressCreateParams {}

property token

token: ProgressToken;

The token to be used to report progress.

interface WorkDoneProgressEnd

interface WorkDoneProgressEnd {}

property kind

kind: 'end';

property message

message?: string;

Optional, a final message indicating to for example indicate the outcome of the operation.

interface WorkDoneProgressOptions

interface WorkDoneProgressOptions {}

property workDoneProgress

workDoneProgress?: boolean;

interface WorkDoneProgressParams

interface WorkDoneProgressParams {}

property workDoneToken

workDoneToken?: ProgressToken;

An optional token that a server can use to report work done progress.

interface WorkDoneProgressReport

interface WorkDoneProgressReport {}

property cancellable

cancellable?: boolean;

Controls enablement state of a cancel button.
Clients that don't support cancellation or don't support controlling the button's enablement state are allowed to ignore the property.

property kind

kind: 'report';

property message

message?: string;

Optional, more detailed associated progress message. Contains complementary information to the title.
Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.

property percentage

percentage?: uinteger;

Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the percentage value in subsequent in report notifications.
The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100]

interface WorkspaceClientCapabilities

interface WorkspaceClientCapabilities {}

Workspace specific client capabilities.

property applyEdit

applyEdit?: boolean;

The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'

property codeLens

codeLens?: CodeLensWorkspaceClientCapabilities;

Capabilities specific to the code lens requests scoped to the workspace.
3.16.0.

property configuration

configuration?: boolean;

The client supports workspace/configuration requests.
3.6.0

property diagnostics

diagnostics?: DiagnosticWorkspaceClientCapabilities;

Capabilities specific to the diagnostic requests scoped to the workspace.
3.17.0.

property didChangeConfiguration

didChangeConfiguration?: DidChangeConfigurationClientCapabilities;

Capabilities specific to the workspace/didChangeConfiguration notification.

property didChangeWatchedFiles

didChangeWatchedFiles?: DidChangeWatchedFilesClientCapabilities;

Capabilities specific to the workspace/didChangeWatchedFiles notification.

property executeCommand

executeCommand?: ExecuteCommandClientCapabilities;

Capabilities specific to the workspace/executeCommand request.

property fileOperations

fileOperations?: FileOperationClientCapabilities;

The client has support for file notifications/requests for user operations on files.
Since 3.16.0

property foldingRange

foldingRange?: FoldingRangeWorkspaceClientCapabilities;

Capabilities specific to the folding range requests scoped to the workspace.
3.18.0

property inlayHint

inlayHint?: InlayHintWorkspaceClientCapabilities;

Capabilities specific to the inlay hint requests scoped to the workspace.
3.17.0.

property inlineValue

inlineValue?: InlineValueWorkspaceClientCapabilities;

Capabilities specific to the inline values requests scoped to the workspace.
3.17.0.

property semanticTokens

semanticTokens?: SemanticTokensWorkspaceClientCapabilities;

Capabilities specific to the semantic token requests scoped to the workspace.
3.16.0.

property symbol

symbol?: WorkspaceSymbolClientCapabilities;

Capabilities specific to the workspace/symbol request.

property workspaceEdit

workspaceEdit?: WorkspaceEditClientCapabilities;

Capabilities specific to WorkspaceEdits.

property workspaceFolders

workspaceFolders?: boolean;

The client has support for workspace folders.
3.6.0

interface WorkspaceEditClientCapabilities

interface WorkspaceEditClientCapabilities {}

property changeAnnotationSupport

changeAnnotationSupport?: {
    /**
     * Whether the client groups edits with equal labels into tree nodes,
     * for instance all edits labelled with "Changes in Strings" would
     * be a tree node.
     */
    groupsOnLabel?: boolean;
};

Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.
3.16.0

property documentChanges

documentChanges?: boolean;

The client supports versioned document changes in WorkspaceEdits

property failureHandling

failureHandling?: FailureHandlingKind;

The failure handling strategy of a client if applying the workspace edit fails.
3.13.0

property normalizesLineEndings

normalizesLineEndings?: boolean;

Whether the client normalizes line endings to the client specific setting. If set to true the client will normalize line ending characters in a workspace edit to the client-specified new line character.
3.16.0

property resourceOperations

resourceOperations?: ResourceOperationKind[];

The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders.
3.13.0

interface WorkspaceFoldersChangeEvent

interface WorkspaceFoldersChangeEvent {}

The workspace folder change event.

property added

added: WorkspaceFolder[];

The array of added workspace folders

property removed

removed: WorkspaceFolder[];

The array of the removed workspace folders

interface WorkspaceSymbolClientCapabilities

interface WorkspaceSymbolClientCapabilities {}

Client capabilities for a WorkspaceSymbolRequest.

property dynamicRegistration

dynamicRegistration?: boolean;

Symbol request supports dynamic registration.

property resolveSupport

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

The client support partial workspace symbols. The client will send the request workspaceSymbol/resolve to the server to resolve additional properties.
3.17.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 workspace/symbol request.

property tagSupport

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

The client supports tags on SymbolInformation. Clients supporting tags have to handle unknown tags gracefully.
3.16.0

interface WorkspaceSymbolOptions

interface WorkspaceSymbolOptions extends WorkDoneProgressOptions {}

Server capabilities for a WorkspaceSymbolRequest.

property resolveProvider

resolveProvider?: boolean;

The server provides support to resolve additional information for a workspace symbol.
3.17.0

interface WorkspaceSymbolParams

interface WorkspaceSymbolParams
    extends WorkDoneProgressParams,
        PartialResultParams {}

The parameters of a WorkspaceSymbolRequest.

property query

query: string;

A query string to filter symbols by. Clients may send an empty string here to request all symbols.

interface WorkspaceSymbolRegistrationOptions

interface WorkspaceSymbolRegistrationOptions extends WorkspaceSymbolOptions {}

Registration options for a WorkspaceSymbolRequest.

Enums

enum MessageDirection

enum MessageDirection {
    clientToServer = 'clientToServer',
    serverToClient = 'serverToClient',
    both = 'both',
}

member both

both = 'both'

member clientToServer

clientToServer = 'clientToServer'

member serverToClient

serverToClient = 'serverToClient'

Type Aliases

type ApplyWorkspaceEditResponse

type ApplyWorkspaceEditResponse = ApplyWorkspaceEditResult;

Deprecated
Use ApplyWorkspaceEditResult instead.

type CompletionTriggerKind

type CompletionTriggerKind = 1 | 2 | 3;

type DiagnosticClientCapabilities

type DiagnosticClientCapabilities = {
    /**
     * 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.
     */
    dynamicRegistration?: boolean;
    /**
     * Whether the clients supports related documents for document diagnostic pulls.
     */
    relatedDocumentSupport?: boolean;
};

Client capabilities specific to diagnostic pull requests.
3.17.0

type DiagnosticOptions

type DiagnosticOptions = WorkDoneProgressOptions & {
    /**
     * An optional identifier under which the diagnostics are
     * managed by the client.
     */
    identifier?: string;
    /**
     * Whether the language has inter file dependencies meaning that
     * editing code in one file can result in a different diagnostic
     * set in another file. Inter file dependencies are common for
     * most programming languages and typically uncommon for linters.
     */
    interFileDependencies: boolean;
    /**
     * The server provides support for workspace diagnostics as well.
     */
    workspaceDiagnostics: boolean;
};

Diagnostic options.
3.17.0

type DiagnosticRegistrationOptions

type DiagnosticRegistrationOptions = TextDocumentRegistrationOptions &
    DiagnosticOptions &
    StaticRegistrationOptions;

Diagnostic registration options.
3.17.0

type DiagnosticServerCancellationData

type DiagnosticServerCancellationData = {
    retriggerRequest: boolean;
};

Cancellation data returned from a diagnostic request.
3.17.0

type DidChangeNotebookDocumentParams

type DidChangeNotebookDocumentParams = {
    /**
     * The notebook document that did change. The version number points
     * to the version after all provided changes have been applied. If
     * only the text document content of a cell changes the notebook version
     * doesn't necessarily have to change.
     */
    notebookDocument: VersionedNotebookDocumentIdentifier;
    /**
     * The actual changes to the notebook document.
     *
     * The changes describe single state changes to the notebook document.
     * So if there are two changes c1 (at array index 0) and c2 (at array
     * index 1) for a notebook in state S then c1 moves the notebook 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 notebook using change events use the following approach:
     * - start with the same initial content
     * - apply the 'notebookDocument/didChange' notifications in the order you receive them.
     * - apply the `NotebookChangeEvent`s in a single notification in the order
     *   you receive them.
     */
    change: NotebookDocumentChangeEvent;
};

The params sent in a change notebook document notification.
3.17.0

type DidCloseNotebookDocumentParams

type DidCloseNotebookDocumentParams = {
    /**
     * The notebook document that got closed.
     */
    notebookDocument: NotebookDocumentIdentifier;
    /**
     * The text documents that represent the content
     * of a notebook cell that got closed.
     */
    cellTextDocuments: TextDocumentIdentifier[];
};

The params sent in a close notebook document notification.
3.17.0

type DidOpenNotebookDocumentParams

type DidOpenNotebookDocumentParams = {
    /**
     * The notebook document that got opened.
     */
    notebookDocument: NotebookDocument;
    /**
     * The text documents that represent the content
     * of a notebook cell.
     */
    cellTextDocuments: TextDocumentItem[];
};

The params sent in an open notebook document notification.
3.17.0

type DidSaveNotebookDocumentParams

type DidSaveNotebookDocumentParams = {
    /**
     * The notebook document that got saved.
     */
    notebookDocument: NotebookDocumentIdentifier;
};

The params sent in a save notebook document notification.
3.17.0

type DocumentDiagnosticParams

type DocumentDiagnosticParams = WorkDoneProgressParams &
    PartialResultParams & {
        /**
         * The text document.
         */
        textDocument: TextDocumentIdentifier;
        /**
         * The additional identifier  provided during registration.
         */
        identifier?: string;
        /**
         * The result id of a previous response if provided.
         */
        previousResultId?: string;
    };

Parameters of the document diagnostic request.
3.17.0

type DocumentDiagnosticReport

type DocumentDiagnosticReport =
    | RelatedFullDocumentDiagnosticReport
    | RelatedUnchangedDocumentDiagnosticReport;

The result of a document diagnostic pull request. A report can either be a full report containing all diagnostics for the requested document or an unchanged report indicating that nothing has changed in terms of diagnostics in comparison to the last pull request.
3.17.0

type DocumentDiagnosticReportKind

type DocumentDiagnosticReportKind = 'full' | 'unchanged';

type DocumentDiagnosticReportPartialResult

type DocumentDiagnosticReportPartialResult = {
    relatedDocuments: {
        [uri: DocumentUri]:
            | FullDocumentDiagnosticReport
            | UnchangedDocumentDiagnosticReport;
    };
};

A partial result for a document diagnostic report.
3.17.0

type DocumentFilter

type DocumentFilter = TextDocumentFilter | NotebookCellTextDocumentFilter;

A document filter describes a top level text document or a notebook cell document.
3.17.0 - proposed support for NotebookCellTextDocumentFilter.

type DocumentSelector

type DocumentSelector = (string | DocumentFilter)[];

A document selector is the combination of one or many document filters.
let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }];
The use of a string as a document filter is deprecated 3.16.0.

type ExecutionSummary

type ExecutionSummary = {
    /**
     * A strict monotonically increasing value
     * indicating the execution order of a cell
     * inside a notebook.
     */
    executionOrder: uinteger;
    /**
     * Whether the execution was successful or
     * not if known by the client.
     */
    success?: boolean;
};

type FailureHandlingKind

type FailureHandlingKind =
    | 'abort'
    | 'transactional'
    | 'undo'
    | 'textOnlyTransactional';

type FileChangeType

type FileChangeType = 1 | 2 | 3;

type FileOperationPatternKind

type FileOperationPatternKind = 'file' | 'folder';

type FullDocumentDiagnosticReport

type FullDocumentDiagnosticReport = {
    /**
     * A full document diagnostic report.
     */
    kind: typeof DocumentDiagnosticReportKind.Full;
    /**
     * An optional result id. If provided it will
     * be sent on the next diagnostic request for the
     * same document.
     */
    resultId?: string;
    /**
     * The actual items.
     */
    items: Diagnostic[];
};

A diagnostic report with a full set of problems.
3.17.0

type GlobPattern

type GlobPattern = Pattern | RelativePattern;

The glob pattern. Either a string pattern or a relative pattern.
3.17.0

type InitializeErrorCodes

type InitializeErrorCodes = 1;

type InitializeParams

type InitializeParams = _InitializeParams & WorkspaceFoldersInitializeParams;

type InlayHintClientCapabilities

type InlayHintClientCapabilities = {
    /**
     * Whether inlay hints support dynamic registration.
     */
    dynamicRegistration?: boolean;
    /**
     * Indicates which properties a client can resolve lazily on an inlay
     * hint.
     */
    resolveSupport?: {
        /**
         * The properties that a client can resolve lazily.
         */
        properties: string[];
    };
};

Inlay hint client capabilities.
3.17.0

type InlayHintOptions

type InlayHintOptions = WorkDoneProgressOptions & {
    /**
     * The server provides support to resolve additional
     * information for an inlay hint item.
     */
    resolveProvider?: boolean;
};

Inlay hint options used during static registration.
3.17.0

type InlayHintParams

type InlayHintParams = WorkDoneProgressParams & {
    /**
     * The text document.
     */
    textDocument: TextDocumentIdentifier;
    /**
     * The document range for which inlay hints should be computed.
     */
    range: Range;
};

A parameter literal used in inlay hint requests.
3.17.0

type InlayHintRegistrationOptions

type InlayHintRegistrationOptions = InlayHintOptions &
    TextDocumentRegistrationOptions &
    StaticRegistrationOptions;

Inlay hint options used during static or dynamic registration.
3.17.0

type InlayHintWorkspaceClientCapabilities

type InlayHintWorkspaceClientCapabilities = {
    /**
     * 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
     * inlay hints currently shown. It should be used with absolute care and
     * is useful for situation where a server for example detects a project wide
     * change that requires such a calculation.
     */
    refreshSupport?: boolean;
};

Client workspace capabilities specific to inlay hints.
3.17.0

type InlineCompletionClientCapabilities

type InlineCompletionClientCapabilities = {
    /**
     * Whether implementation supports dynamic registration for inline completion providers.
     */
    dynamicRegistration?: boolean;
};

Client capabilities specific to inline completions.
3.18.0

type InlineCompletionOptions

type InlineCompletionOptions = WorkDoneProgressOptions;

Inline completion options used during static registration.
3.18.0

type InlineCompletionParams

type InlineCompletionParams = WorkDoneProgressParams &
    TextDocumentPositionParams & {
        /**
         * Additional information about the context in which inline completions were
         * requested.
         */
        context: InlineCompletionContext;
    };

A parameter literal used in inline completion requests.
3.18.0

type InlineCompletionRegistrationOptions

type InlineCompletionRegistrationOptions = InlineCompletionOptions &
    TextDocumentRegistrationOptions &
    StaticRegistrationOptions;

Inline completion options used during static or dynamic registration.
3.18.0

type InlineValueClientCapabilities

type InlineValueClientCapabilities = {
    /**
     * Whether implementation supports dynamic registration for inline value providers.
     */
    dynamicRegistration?: boolean;
};

Client capabilities specific to inline values.
3.17.0

type InlineValueOptions

type InlineValueOptions = WorkDoneProgressOptions;

Inline value options used during static registration.
3.17.0

type InlineValueParams

type InlineValueParams = WorkDoneProgressParams & {
    /**
     * The text document.
     */
    textDocument: TextDocumentIdentifier;
    /**
     * The document range for which inline values should be computed.
     */
    range: Range;
    /**
     * Additional information about the context in which inline values were
     * requested.
     */
    context: InlineValueContext;
};

A parameter literal used in inline value requests.
3.17.0

type InlineValueRegistrationOptions

type InlineValueRegistrationOptions = InlineValueOptions &
    TextDocumentRegistrationOptions &
    StaticRegistrationOptions;

Inline value options used during static or dynamic registration.
3.17.0

type InlineValueWorkspaceClientCapabilities

type InlineValueWorkspaceClientCapabilities = {
    /**
     * 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
     * inline values currently shown. It should be used with absolute care and is
     * useful for situation where a server for example detects a project wide
     * change that requires such a calculation.
     */
    refreshSupport?: boolean;
};

Client workspace capabilities specific to inline values.
3.17.0

type LSPErrorCodes

type LSPErrorCodes = integer;

type MessageType

type MessageType = 1 | 2 | 3 | 4 | 5;

type MonikerKind

type MonikerKind = 'import' | 'export' | 'local';

type NotebookCell

type NotebookCell = {
    /**
     * The cell's kind
     */
    kind: NotebookCellKind;
    /**
     * The URI of the cell's text document
     * content.
     */
    document: DocumentUri;
    /**
     * Additional metadata stored with the cell.
     *
     * Note: should always be an object literal (e.g. LSPObject)
     */
    metadata?: LSPObject;
    /**
     * Additional execution summary information
     * if supported by the client.
     */
    executionSummary?: ExecutionSummary;
};

A notebook cell.
A cell's document URI must be unique across ALL notebook cells and can therefore be used to uniquely identify a notebook cell or the cell's text document.
3.17.0

type NotebookCellArrayChange

type NotebookCellArrayChange = {
    /**
     * The start oftest of the cell that changed.
     */
    start: uinteger;
    /**
     * The deleted cells
     */
    deleteCount: uinteger;
    /**
     * The new cells, if any
     */
    cells?: NotebookCell[];
};

A change describing how to move a NotebookCell array from state S to S'.
3.17.0

type NotebookCellKind

type NotebookCellKind = 1 | 2;

type NotebookCellTextDocumentFilter

type NotebookCellTextDocumentFilter = {
    /**
     * A filter that matches against the notebook
     * containing the notebook cell. If a string
     * value is provided it matches against the
     * notebook type. '*' matches every notebook.
     */
    notebook: string | NotebookDocumentFilter;
    /**
     * A language id like `python`.
     *
     * Will be matched against the language id of the
     * notebook cell document. '*' matches every language.
     */
    language?: string;
};

A notebook cell text document filter denotes a cell text document by different properties.
3.17.0

type NotebookDocument

type NotebookDocument = {
    /**
     * The notebook document's uri.
     */
    uri: URI;
    /**
     * The type of the notebook.
     */
    notebookType: string;
    /**
     * The version number of this document (it will increase after each
     * change, including undo/redo).
     */
    version: integer;
    /**
     * Additional metadata stored with the notebook
     * document.
     *
     * Note: should always be an object literal (e.g. LSPObject)
     */
    metadata?: LSPObject;
    /**
     * The cells of a notebook.
     */
    cells: NotebookCell[];
};

A notebook document.
3.17.0

type NotebookDocumentChangeEvent

type NotebookDocumentChangeEvent = {
    /**
     * The changed meta data if any.
     *
     * Note: should always be an object literal (e.g. LSPObject)
     */
    metadata?: LSPObject;
    /**
     * Changes to cells
     */
    cells?: {
        /**
         * Changes to the cell structure to add or
         * remove cells.
         */
        structure?: {
            /**
             * The change to the cell array.
             */
            array: NotebookCellArrayChange;
            /**
             * Additional opened cell text documents.
             */
            didOpen?: TextDocumentItem[];
            /**
             * Additional closed cell text documents.
             */
            didClose?: TextDocumentIdentifier[];
        };
        /**
         * Changes to notebook cells properties like its
         * kind, execution summary or metadata.
         */
        data?: NotebookCell[];
        /**
         * Changes to the text content of notebook cells.
         */
        textContent?: {
            document: VersionedTextDocumentIdentifier;
            changes: TextDocumentContentChangeEvent[];
        }[];
    };
};

A change event for a notebook document.
3.17.0

type NotebookDocumentFilter

type NotebookDocumentFilter =
    | {
          /** The type of the enclosing notebook. */
          notebookType: string;
          /** A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. */
          scheme?: string;
          /** A glob pattern. */
          pattern?: string;
      }
    | {
          /** The type of the enclosing notebook. */
          notebookType?: string;
          /** A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.*/
          scheme: string;
          /** A glob pattern. */
          pattern?: string;
      }
    | {
          /** The type of the enclosing notebook. */
          notebookType?: string;
          /** A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. */
          scheme?: string;
          /** A glob pattern. */
          pattern: string;
      };

A notebook document filter denotes a notebook document by different properties. The properties will be match against the notebook's URI (same as with documents)
3.17.0

type NotebookDocumentIdentifier

type NotebookDocumentIdentifier = {
    /**
     * The notebook document's uri.
     */
    uri: URI;
};

A literal to identify a notebook document in the client.
3.17.0

type NotebookDocumentSyncClientCapabilities

type NotebookDocumentSyncClientCapabilities = {
    /**
     * 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.
     */
    dynamicRegistration?: boolean;
    /**
     * The client supports sending execution summary data per cell.
     */
    executionSummarySupport?: boolean;
};

Notebook specific client capabilities.
3.17.0

type NotebookDocumentSyncOptions

type NotebookDocumentSyncOptions = {
    /**
     * The notebooks to be synced
     */
    notebookSelector: (
        | {
              /**
               * The notebook to be synced If a string
               * value is provided it matches against the
               * notebook type. '*' matches every notebook.
               */
              notebook: string | NotebookDocumentFilter;
              /**
               * The cells of the matching notebook to be synced.
               */
              cells?: {
                  language: string;
              }[];
          }
        | {
              /**
               * The notebook to be synced If a string
               * value is provided it matches against the
               * notebook type. '*' matches every notebook.
               */
              notebook?: string | NotebookDocumentFilter;
              /**
               * The cells of the matching notebook to be synced.
               */
              cells: {
                  language: string;
              }[];
          }
    )[];
    /**
     * Whether save notification should be forwarded to
     * the server. Will only be honored if mode === `notebook`.
     */
    save?: boolean;
};

Options specific to a notebook plus its cells to be synced to the server.
If a selector provides a notebook document filter but no cell selector all cells of a matching notebook document will be synced.
If a selector provides no notebook document filter but only a cell selector all notebook document that contain at least one matching cell will be synced.
3.17.0

type NotebookDocumentSyncRegistrationOptions

type NotebookDocumentSyncRegistrationOptions = NotebookDocumentSyncOptions &
    StaticRegistrationOptions;

Registration options specific to a notebook.
3.17.0

type Pattern

type Pattern = string;

The glob pattern to watch relative to the base path. Glob patterns can have the following syntax: - * to match one or more characters in a path segment - ? to match on one character in a path segment - ** to match any number of path segments, including none - {} to group conditions (e.g. **/*.{ts,js} matches all TypeScript and JavaScript files) - [] to declare a range of characters to match in a path segment (e.g., example.[0-9] to match on example.0, example.1, …) - [!...] to negate a range of characters to match in a path segment (e.g., example.[!0-9] to match on example.a, example.b, but not example.0)
3.17.0

type PositionEncodingKind

type PositionEncodingKind = string;

A type indicating how positions are encoded, specifically what column offsets mean.
3.17.0

type PrepareRenameResult

type PrepareRenameResult =
    | Range
    | {
          range: Range;
          placeholder: string;
      }
    | {
          defaultBehavior: boolean;
      };

type PrepareSupportDefaultBehavior

type PrepareSupportDefaultBehavior = 1;

type PreviousResultId

type PreviousResultId = {
    /**
     * The URI for which the client knowns a
     * result id.
     */
    uri: DocumentUri;
    /**
     * The value of the previous result id.
     */
    value: string;
};

A previous result id in a workspace pull request.
3.17.0

type RelatedFullDocumentDiagnosticReport

type RelatedFullDocumentDiagnosticReport = FullDocumentDiagnosticReport & {
    /**
     * Diagnostics of related documents. This information is useful
     * in programming languages where code in a file A can generate
     * diagnostics in a file B which A depends on. An example of
     * such a language is C/C++ where marco definitions in a file
     * a.cpp and result in errors in a header file b.hpp.
     *
     * @since 3.17.0
     */
    relatedDocuments?: {
        [uri: DocumentUri]:
            | FullDocumentDiagnosticReport
            | UnchangedDocumentDiagnosticReport;
    };
};

A full diagnostic report with a set of related documents.
3.17.0

type RelatedUnchangedDocumentDiagnosticReport

type RelatedUnchangedDocumentDiagnosticReport = UnchangedDocumentDiagnosticReport & {
    /**
     * Diagnostics of related documents. This information is useful
     * in programming languages where code in a file A can generate
     * diagnostics in a file B which A depends on. An example of
     * such a language is C/C++ where marco definitions in a file
     * a.cpp and result in errors in a header file b.hpp.
     *
     * @since 3.17.0
     */
    relatedDocuments?: {
        [uri: DocumentUri]:
            | FullDocumentDiagnosticReport
            | UnchangedDocumentDiagnosticReport;
    };
};

An unchanged diagnostic report with a set of related documents.
3.17.0

type ResourceOperationKind

type ResourceOperationKind = 'create' | 'rename' | 'delete';

The kind of resource operations supported by the client.

type SignatureHelpTriggerKind

type SignatureHelpTriggerKind = 1 | 2 | 3;

type TextDocumentContentChangeEvent

type TextDocumentContentChangeEvent =
    | {
          /**
           * The range of the document that changed.
           */
          range: Range;
          /**
           * The optional length of the range that got replaced.
           *
           * @deprecated use range instead.
           */
          rangeLength?: uinteger;
          /**
           * The new text for the provided range.
           */
          text: string;
      }
    | {
          /**
           * The new text of the whole document.
           */
          text: string;
      };

An event describing a change to a text document. If only a text is provided it is considered to be the full content of the document.

type TextDocumentFilter

type TextDocumentFilter =
    | {
          /** A language id, like `typescript`. */
          language: string;
          /** A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. */
          scheme?: string;
          /** A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples. */
          pattern?: string;
      }
    | {
          /** A language id, like `typescript`. */
          language?: string;
          /** A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. */
          scheme: string;
          /** A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples. */
          pattern?: string;
      }
    | {
          /** A language id, like `typescript`. */
          language?: string;
          /** A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. */
          scheme?: string;
          /** A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples. */
          pattern: string;
      };

A document filter denotes a document by different properties like the , the of its resource, or a glob-pattern that is applied to the .
Glob patterns can have the following syntax: - * to match one or more characters in a path segment - ? to match on one character in a path segment - ** to match any number of path segments, including none - {} to group sub patterns into an OR expression. (e.g. **/*.{ts,js} matches all TypeScript and JavaScript files) - [] to declare a range of characters to match in a path segment (e.g., example.[0-9] to match on example.0, example.1, …) - [!...] to negate a range of characters to match in a path segment (e.g., example.[!0-9] to match on example.a, example.b, but not example.0)
A language filter that applies to typescript files on disk: { language: 'typescript', scheme: 'file' } A language filter that applies to all package.json paths: { language: 'json', pattern: '**package.json' }
3.17.0

type TextDocumentSaveReason

type TextDocumentSaveReason = 1 | 2 | 3;

type TextDocumentSyncKind

type TextDocumentSyncKind = 0 | 1 | 2;

type TokenFormat

type TokenFormat = 'relative';

type TypeHierarchyClientCapabilities

type TypeHierarchyClientCapabilities = {
    /**
     * 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.
     */
    dynamicRegistration?: boolean;
};

3.17.0

type TypeHierarchyOptions

type TypeHierarchyOptions = WorkDoneProgressOptions;

Type hierarchy options used during static registration.
3.17.0

type TypeHierarchyPrepareParams

type TypeHierarchyPrepareParams = TextDocumentPositionParams &
    WorkDoneProgressParams;

The parameter of a textDocument/prepareTypeHierarchy request.
3.17.0

type TypeHierarchyRegistrationOptions

type TypeHierarchyRegistrationOptions = TextDocumentRegistrationOptions &
    TypeHierarchyOptions &
    StaticRegistrationOptions;

Type hierarchy options used during static or dynamic registration.
3.17.0

type TypeHierarchySubtypesParams

type TypeHierarchySubtypesParams = WorkDoneProgressParams &
    PartialResultParams & {
        item: TypeHierarchyItem;
    };

The parameter of a typeHierarchy/subtypes request.
3.17.0

type TypeHierarchySupertypesParams

type TypeHierarchySupertypesParams = WorkDoneProgressParams &
    PartialResultParams & {
        item: TypeHierarchyItem;
    };

The parameter of a typeHierarchy/supertypes request.
3.17.0

type UnchangedDocumentDiagnosticReport

type UnchangedDocumentDiagnosticReport = {
    /**
     * A document diagnostic report indicating
     * no changes to the last result. A server can
     * only return `unchanged` if result ids are
     * provided.
     */
    kind: typeof DocumentDiagnosticReportKind.Unchanged;
    /**
     * A result id which will be sent on the next
     * diagnostic request for the same document.
     */
    resultId: string;
};

A diagnostic report indicating that the last returned report is still accurate.
3.17.0

type UniquenessLevel

type UniquenessLevel = 'document' | 'project' | 'group' | 'scheme' | 'global';

type VersionedNotebookDocumentIdentifier

type VersionedNotebookDocumentIdentifier = {
    /**
     * The version number of this notebook document.
     */
    version: integer;
    /**
     * The notebook document's uri.
     */
    uri: URI;
};

A versioned notebook document identifier.
3.17.0

type WatchKind

type WatchKind = uinteger;

type WorkspaceDiagnosticParams

type WorkspaceDiagnosticParams = WorkDoneProgressParams &
    PartialResultParams & {
        /**
         * The additional identifier provided during registration.
         */
        identifier?: string;
        /**
         * The currently known diagnostic reports with their
         * previous result ids.
         */
        previousResultIds: PreviousResultId[];
    };

Parameters of the workspace diagnostic request.
3.17.0

type WorkspaceDiagnosticReport

type WorkspaceDiagnosticReport = {
    items: WorkspaceDocumentDiagnosticReport[];
};

A workspace diagnostic report.
3.17.0

type WorkspaceDiagnosticReportPartialResult

type WorkspaceDiagnosticReportPartialResult = {
    items: WorkspaceDocumentDiagnosticReport[];
};

A partial result for a workspace diagnostic report.
3.17.0

type WorkspaceDocumentDiagnosticReport

type WorkspaceDocumentDiagnosticReport =
    | WorkspaceFullDocumentDiagnosticReport
    | WorkspaceUnchangedDocumentDiagnosticReport;

A workspace diagnostic document report.
3.17.0

type WorkspaceFullDocumentDiagnosticReport

type WorkspaceFullDocumentDiagnosticReport = FullDocumentDiagnosticReport & {
    /**
     * The URI for which diagnostic information is reported.
     */
    uri: DocumentUri;
    /**
     * The version number for which the diagnostics are reported.
     * If the document is not marked as open `null` can be provided.
     */
    version: integer | null;
};

A full document diagnostic report for a workspace diagnostic result.
3.17.0

type WorkspaceUnchangedDocumentDiagnosticReport

type WorkspaceUnchangedDocumentDiagnosticReport =
    UnchangedDocumentDiagnosticReport & {
        /**
         * The URI for which diagnostic information is reported.
         */
        uri: DocumentUri;
        /**
         * The version number for which the diagnostics are reported.
         * If the document is not marked as open `null` can be provided.
         */
        version: integer | null;
    };

An unchanged document diagnostic report for a workspace diagnostic result.
3.17.0

Namespaces

namespace ApplyWorkspaceEditRequest

namespace ApplyWorkspaceEditRequest {}

A request sent from the server to the client to modified certain resources.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    ApplyWorkspaceEditParams,
    ApplyWorkspaceEditResult,
    never,
    void,
    void
>;

namespace CallHierarchyIncomingCallsRequest

namespace CallHierarchyIncomingCallsRequest {}

A request to resolve the incoming calls for a given CallHierarchyItem.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    CallHierarchyIncomingCallsParams,
    CallHierarchyIncomingCall[],
    CallHierarchyIncomingCall[],
    void,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    CallHierarchyIncomingCallsParams,
    CallHierarchyIncomingCall[] | null,
    void
>;

namespace CallHierarchyOutgoingCallsRequest

namespace CallHierarchyOutgoingCallsRequest {}

A request to resolve the outgoing calls for a given CallHierarchyItem.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    CallHierarchyOutgoingCallsParams,
    CallHierarchyOutgoingCall[],
    CallHierarchyOutgoingCall[],
    void,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    CallHierarchyOutgoingCallsParams,
    CallHierarchyOutgoingCall[] | null,
    void
>;

namespace CallHierarchyPrepareRequest

namespace CallHierarchyPrepareRequest {}

A request to result a CallHierarchyItem in a document at a given position. Can be used as an input to an incoming or outgoing call hierarchy.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    CallHierarchyPrepareParams,
    CallHierarchyItem[],
    never,
    void,
    CallHierarchyRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    CallHierarchyPrepareParams,
    CallHierarchyItem[] | null,
    void
>;

namespace CodeActionRequest

namespace CodeActionRequest {}

A request to provide commands for the given text document and range.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    CodeActionParams,
    any[],
    any[],
    void,
    CodeActionRegistrationOptions
>;

namespace CodeActionResolveRequest

namespace CodeActionResolveRequest {}

Request to resolve additional information for a given code action.The request's parameter is of type CodeAction the response is of type CodeAction or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<CodeAction, CodeAction, never, void, void>;

namespace CodeLensRefreshRequest

namespace CodeLensRefreshRequest {}

A request to refresh all code actions
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<void, void, void, void>;

namespace CodeLensRequest

namespace CodeLensRequest {}

A request to provide code lens for the given text document.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    CodeLensParams,
    CodeLens[],
    CodeLens[],
    void,
    CodeLensRegistrationOptions
>;

namespace CodeLensResolveRequest

namespace CodeLensResolveRequest {}

A request to resolve a command for a given code lens.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<CodeLens, CodeLens, never, void, void>;

namespace ColorPresentationRequest

namespace ColorPresentationRequest {}

A request to list all presentation for a color. The request's parameter is of type ColorPresentationParams the response is of type or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    ColorPresentationParams,
    ColorPresentation[],
    ColorPresentation[],
    void,
    WorkDoneProgressOptions & TextDocumentRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    ColorPresentationParams,
    ColorPresentation[],
    void
>;

namespace CompletionRequest

namespace CompletionRequest {}

Request to request completion at a given text document position. The request's parameter is of type TextDocumentPosition the response is of type or CompletionList or a Thenable that resolves to such.
The request can delay the computation of the and properties to the completionItem/resolve request. However, properties that are needed for the initial sorting and filtering, like sortText, filterText, insertText, and textEdit, must not be changed during resolve.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    CompletionParams,
    any,
    CompletionItem[],
    void,
    CompletionRegistrationOptions
>;

namespace CompletionResolveRequest

namespace CompletionResolveRequest {}

Request to resolve additional information for a given completion item.The request's parameter is of type CompletionItem the response is of type CompletionItem or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<CompletionItem, CompletionItem, never, void, void>;

namespace CompletionTriggerKind

namespace CompletionTriggerKind {}

How a completion was triggered

variable Invoked

const Invoked: number;

Completion was triggered by typing an identifier (24x7 code complete), manual invocation (e.g Ctrl+Space) or via API.

variable TriggerCharacter

const TriggerCharacter: number;

Completion was triggered by a trigger character specified by the triggerCharacters properties of the CompletionRegistrationOptions.

variable TriggerForIncompleteCompletions

const TriggerForIncompleteCompletions: number;

Completion was re-triggered as current completion list is incomplete

namespace ConfigurationRequest

namespace ConfigurationRequest {}

The 'workspace/configuration' request is sent from the server to the client to fetch a certain configuration setting.
This pull model replaces the old push model were the client signaled configuration change via an event. If the server still needs to react to configuration changes (since the server caches the result of workspace/configuration requests) the server should register for an empty configuration change event and empty the cache if such an event is received.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<ConfigurationParams, any[], never, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler<ConfigurationParams, LSPAny[], void>;

type MiddlewareSignature

type MiddlewareSignature = (
    params: ConfigurationParams,
    token: CancellationToken,
    next: HandlerSignature
) => HandlerResult<LSPAny[], void>;

namespace DeclarationRequest

namespace DeclarationRequest {}

A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type TextDocumentPositionParams the response is of type Declaration or a typed array of DeclarationLink or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DeclarationParams,
    any,
    LocationLink[] | Location[],
    void,
    DeclarationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    DeclarationParams,
    Declaration | DeclarationLink[] | null,
    void
>;

namespace DefinitionRequest

namespace DefinitionRequest {}

A request to resolve the definition location of a symbol at a given text document position. The request's parameter is of type TextDocumentPosition the response is of either type Definition or a typed array of DefinitionLink or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DefinitionParams,
    any,
    LocationLink[] | Location[],
    void,
    DefinitionRegistrationOptions
>;

namespace DiagnosticRefreshRequest

namespace DiagnosticRefreshRequest {}

The diagnostic refresh request definition.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<void, void, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler0<void, void>;

namespace DiagnosticServerCancellationData

namespace DiagnosticServerCancellationData {}

3.17.0

function is

is: (value: any) => value is DiagnosticServerCancellationData;

namespace DidChangeConfigurationNotification

namespace DidChangeConfigurationNotification {}

The configuration change notification is sent from the client to the server when the client's configuration has changed. The notification contains the changed configuration as defined by the language client.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    DidChangeConfigurationParams,
    DidChangeConfigurationRegistrationOptions
>;

namespace DidChangeNotebookDocumentNotification

namespace DidChangeNotebookDocumentNotification {}

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable registrationMethod

const registrationMethod: string;

variable type

const type: ProtocolNotificationType<DidChangeNotebookDocumentParams, void>;

namespace DidChangeTextDocumentNotification

namespace DidChangeTextDocumentNotification {}

The document change notification is sent from the client to the server to signal changes to a text document.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    DidChangeTextDocumentParams,
    TextDocumentChangeRegistrationOptions
>;

namespace DidChangeWatchedFilesNotification

namespace DidChangeWatchedFilesNotification {}

The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    DidChangeWatchedFilesParams,
    DidChangeWatchedFilesRegistrationOptions
>;

namespace DidChangeWorkspaceFoldersNotification

namespace DidChangeWorkspaceFoldersNotification {}

The workspace/didChangeWorkspaceFolders notification is sent from the client to the server when the workspace folder configuration changes.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<DidChangeWorkspaceFoldersParams, void>;

type HandlerSignature

type HandlerSignature = NotificationHandler<DidChangeWorkspaceFoldersParams>;

type MiddlewareSignature

type MiddlewareSignature = (
    params: DidChangeWorkspaceFoldersParams,
    next: HandlerSignature
) => void;

namespace DidCloseNotebookDocumentNotification

namespace DidCloseNotebookDocumentNotification {}

A notification sent when a notebook closes.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable registrationMethod

const registrationMethod: string;

variable type

const type: ProtocolNotificationType<DidCloseNotebookDocumentParams, void>;

namespace DidCloseTextDocumentNotification

namespace DidCloseTextDocumentNotification {}

The document close notification is sent from the client to the server when the document got closed in the client. The document's truth now exists where the document's uri points to (e.g. if the document's uri is a file uri the truth now exists on disk). As with the open notification the close notification is about managing the document's content. Receiving a close notification doesn't mean that the document was open in an editor before. A close notification requires a previous open notification to be sent.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    DidCloseTextDocumentParams,
    TextDocumentRegistrationOptions
>;

namespace DidCreateFilesNotification

namespace DidCreateFilesNotification {}

The did create files notification is sent from the client to the server when files were created from within the client.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    CreateFilesParams,
    FileOperationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = NotificationHandler<CreateFilesParams>;

namespace DidDeleteFilesNotification

namespace DidDeleteFilesNotification {}

The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    DeleteFilesParams,
    FileOperationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = NotificationHandler<DeleteFilesParams>;

namespace DidOpenNotebookDocumentNotification

namespace DidOpenNotebookDocumentNotification {}

A notification sent when a notebook opens.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable registrationMethod

const registrationMethod: string;

variable type

const type: ProtocolNotificationType<DidOpenNotebookDocumentParams, void>;

namespace DidOpenTextDocumentNotification

namespace DidOpenTextDocumentNotification {}

The document open notification is sent from the client to the server to signal newly opened text documents. The document's truth is now managed by the client and the server must not try to read the document's truth using the document's uri. Open in this sense means it is managed by the client. It doesn't necessarily mean that its content is presented in an editor. An open notification must not be sent more than once without a corresponding close notification send before. This means open and close notification must be balanced and the max open count is one.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    DidOpenTextDocumentParams,
    TextDocumentRegistrationOptions
>;

namespace DidRenameFilesNotification

namespace DidRenameFilesNotification {}

The did rename files notification is sent from the client to the server when files were renamed from within the client.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    RenameFilesParams,
    FileOperationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = NotificationHandler<RenameFilesParams>;

namespace DidSaveNotebookDocumentNotification

namespace DidSaveNotebookDocumentNotification {}

A notification sent when a notebook document is saved.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable registrationMethod

const registrationMethod: string;

variable type

const type: ProtocolNotificationType<DidSaveNotebookDocumentParams, void>;

namespace DidSaveTextDocumentNotification

namespace DidSaveTextDocumentNotification {}

The document save notification is sent from the client to the server when the document got saved in the client.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    DidSaveTextDocumentParams,
    TextDocumentSaveRegistrationOptions
>;

namespace DocumentColorRequest

namespace DocumentColorRequest {}

A request to list all color symbols found in a given text document. The request's parameter is of type DocumentColorParams the response is of type or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentColorParams,
    ColorInformation[],
    ColorInformation[],
    void,
    DocumentColorRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    DocumentColorParams,
    ColorInformation[],
    void
>;

namespace DocumentDiagnosticReportKind

namespace DocumentDiagnosticReportKind {}

The document diagnostic report kinds.
3.17.0

variable Full

const Full: string;

A diagnostic report with a full set of problems.

variable Unchanged

const Unchanged: string;

A report indicating that the last returned report is still accurate.

namespace DocumentDiagnosticRequest

namespace DocumentDiagnosticRequest {}

The document diagnostic request definition.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable partialResult

const partialResult: ProgressType<DocumentDiagnosticReportPartialResult>;

variable type

const type: ProtocolRequestType<
    DocumentDiagnosticParams,
    DocumentDiagnosticReport,
    DocumentDiagnosticReportPartialResult,
    DiagnosticServerCancellationData,
    DiagnosticRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    DocumentDiagnosticParams,
    DocumentDiagnosticReport,
    void
>;

namespace DocumentFormattingRequest

namespace DocumentFormattingRequest {}

A request to format a whole document.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentFormattingParams,
    TextEdit[],
    never,
    void,
    DocumentFormattingRegistrationOptions
>;

namespace DocumentHighlightRequest

namespace DocumentHighlightRequest {}

Request to resolve a DocumentHighlight for a given text document position. The request's parameter is of type TextDocumentPosition the request response is an array of type DocumentHighlight or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentHighlightParams,
    DocumentHighlight[],
    DocumentHighlight[],
    void,
    DocumentHighlightRegistrationOptions
>;

namespace DocumentLinkRequest

namespace DocumentLinkRequest {}

A request to provide document links

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentLinkParams,
    DocumentLink[],
    DocumentLink[],
    void,
    DocumentLinkRegistrationOptions
>;

namespace DocumentLinkResolveRequest

namespace DocumentLinkResolveRequest {}

Request to resolve additional information for a given document link. The request's parameter is of type DocumentLink the response is of type DocumentLink or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<DocumentLink, DocumentLink, never, void, void>;

namespace DocumentOnTypeFormattingRequest

namespace DocumentOnTypeFormattingRequest {}

A request to format a document on type.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentOnTypeFormattingParams,
    TextEdit[],
    never,
    void,
    DocumentOnTypeFormattingRegistrationOptions
>;

namespace DocumentRangeFormattingRequest

namespace DocumentRangeFormattingRequest {}

A request to format a range in a document.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentRangeFormattingParams,
    TextEdit[],
    never,
    void,
    DocumentRangeFormattingRegistrationOptions
>;

namespace DocumentRangesFormattingRequest

namespace DocumentRangesFormattingRequest {}

A request to format ranges in a document.
3.18.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentRangesFormattingParams,
    TextEdit[],
    never,
    void,
    DocumentRangeFormattingRegistrationOptions
>;

namespace DocumentSelector

namespace DocumentSelector {}

The DocumentSelector namespace provides helper functions to work with DocumentSelectors.

function is

is: (value: any[] | undefined | null) => value is DocumentSelector;

namespace DocumentSymbolRequest

namespace DocumentSymbolRequest {}

A request to list all symbols found in a given text document. The request's parameter is of type TextDocumentIdentifier the response is of type or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DocumentSymbolParams,
    DocumentSymbol[] | SymbolInformation[],
    DocumentSymbol[] | SymbolInformation[],
    void,
    DocumentSymbolRegistrationOptions
>;

namespace ExecuteCommandRequest

namespace ExecuteCommandRequest {}

A request send from the client to the server to execute a command. The request might return a workspace edit which the client will apply to the workspace.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    ExecuteCommandParams,
    any,
    never,
    void,
    ExecuteCommandRegistrationOptions
>;

namespace ExecutionSummary

namespace ExecutionSummary {}

function create

create: (executionOrder: number, success?: boolean) => ExecutionSummary;

function equals

equals: (
    one: ExecutionSummary | undefined,
    other: ExecutionSummary | undefined
) => boolean;

function is

is: (value: any) => value is ExecutionSummary;

namespace ExitNotification

namespace ExitNotification {}

The exit event is sent from the client to the server to ask the server to exit its process.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType0<void>;

namespace FailureHandlingKind

namespace FailureHandlingKind {}

variable Abort

const Abort: FailureHandlingKind;

Applying the workspace change is simply aborted if one of the changes provided fails. All operations executed before the failing operation stay executed.

variable TextOnlyTransactional

const TextOnlyTransactional: FailureHandlingKind;

If the workspace edit contains only textual file changes they are executed transactional. If resource changes (create, rename or delete file) are part of the change the failure handling strategy is abort.

variable Transactional

const Transactional: FailureHandlingKind;

All operations are executed transactional. That means they either all succeed or no changes at all are applied to the workspace.

variable Undo

const Undo: FailureHandlingKind;

The client tries to undo the operations already executed. But there is no guarantee that this is succeeding.

namespace FileChangeType

namespace FileChangeType {}

The file event type

variable Changed

const Changed: number;

The file got changed.

variable Created

const Created: number;

The file got created.

variable Deleted

const Deleted: number;

The file got deleted.

namespace FileOperationPatternKind

namespace FileOperationPatternKind {}

A pattern kind describing if a glob pattern matches a file a folder or both.
3.16.0

variable file

const file: string;

The pattern matches a file only.

variable folder

const folder: string;

The pattern matches a folder only.

namespace FoldingRangeRefreshRequest

namespace FoldingRangeRefreshRequest {}

3.18.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<void, void, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler0<void, void>;

namespace FoldingRangeRequest

namespace FoldingRangeRequest {}

A request to provide folding ranges in a document. The request's parameter is of type FoldingRangeParams, the response is of type FoldingRangeList or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    FoldingRangeParams,
    FoldingRange[],
    FoldingRange[],
    void,
    FoldingRangeRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    FoldingRangeParams,
    FoldingRange[] | null,
    void
>;

namespace HoverRequest

namespace HoverRequest {}

Request to request hover information at a given text document position. The request's parameter is of type TextDocumentPosition the response is of type Hover or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    HoverParams,
    any,
    never,
    void,
    HoverRegistrationOptions
>;

namespace ImplementationRequest

namespace ImplementationRequest {}

A request to resolve the implementation locations of a symbol at a given text document position. The request's parameter is of type TextDocumentPositionParams the response is of type Definition or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    ImplementationParams,
    any,
    LocationLink[] | Location[],
    void,
    ImplementationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    ImplementationParams,
    Definition | DefinitionLink[] | null,
    void
>;

namespace InitializedNotification

namespace InitializedNotification {}

The initialized notification is sent from the client to the server after the client is fully initialized and the server is allowed to send requests from the server to the client.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<InitializedParams, void>;

namespace InitializeErrorCodes

namespace InitializeErrorCodes {}

Known error codes for an InitializeErrorCodes;

variable unknownProtocolVersion

const unknownProtocolVersion: number;

If the protocol version provided by the client can't be handled by the server.
Deprecated
This initialize error got replaced by client capabilities. There is no version handshake in version 3.0x

namespace InitializeRequest

namespace InitializeRequest {}

The initialize request is sent from the client to the server. It is sent once as the request after starting up the server. The requests parameter is of type InitializeParams the response if of type InitializeResult of a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    InitializeParams,
    InitializeResult<any>,
    never,
    InitializeError,
    void
>;

namespace InlayHintRefreshRequest

namespace InlayHintRefreshRequest {}

3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<void, void, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler0<void, void>;

namespace InlayHintRequest

namespace InlayHintRequest {}

A request to provide inlay hints in a document. The request's parameter is of type InlayHintsParams, the response is of type or a Thenable that resolves to such.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    InlayHintParams,
    InlayHint[],
    InlayHint[],
    void,
    InlayHintRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<InlayHintParams, InlayHint[] | null, void>;

namespace InlayHintResolveRequest

namespace InlayHintResolveRequest {}

A request to resolve additional properties for an inlay hint. The request's parameter is of type InlayHint, the response is of type InlayHint or a Thenable that resolves to such.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<InlayHint, InlayHint, never, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler<InlayHint, InlayHint, void>;

namespace InlineCompletionRequest

namespace InlineCompletionRequest {}

A request to provide inline completions in a document. The request's parameter is of type InlineCompletionParams, the response is of type or a Thenable that resolves to such.
3.18.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    InlineCompletionParams,
    any,
    InlineCompletionItem[],
    void,
    InlineCompletionRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    InlineCompletionParams,
    InlineCompletionList | InlineCompletionItem[] | null,
    void
>;

namespace InlineValueRefreshRequest

namespace InlineValueRefreshRequest {}

3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<void, void, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler0<void, void>;

namespace InlineValueRequest

namespace InlineValueRequest {}

A request to provide inline values in a document. The request's parameter is of type InlineValueParams, the response is of type or a Thenable that resolves to such.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    InlineValueParams,
    InlineValue[],
    InlineValue[],
    void,
    InlineValueRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    InlineValueParams,
    InlineValue[] | null,
    void
>;

namespace LinkedEditingRangeRequest

namespace LinkedEditingRangeRequest {}

A request to provide ranges that can be edited together.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    LinkedEditingRangeParams,
    LinkedEditingRanges,
    void,
    void,
    LinkedEditingRangeRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    LinkedEditingRangeParams,
    LinkedEditingRanges | null,
    void
>;

namespace LogMessageNotification

namespace LogMessageNotification {}

The log message notification is sent from the server to the client to ask the client to log a particular message.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<LogMessageParams, void>;

namespace LSPErrorCodes

namespace LSPErrorCodes {}

variable ContentModified

const ContentModified: integer;

The server detected that the content of a document got modified outside normal conditions. A server should NOT send this error code if it detects a content change in it unprocessed messages. The result even computed on an older state might still be useful for the client.
If a client decides that a result is not of any use anymore the client should cancel the request.

variable lspReservedErrorRangeEnd

const lspReservedErrorRangeEnd: integer;

This is the end range of LSP reserved error codes. It doesn't denote a real error code.
3.16.0

variable lspReservedErrorRangeStart

const lspReservedErrorRangeStart: integer;

This is the start range of LSP reserved error codes. It doesn't denote a real error code.
3.16.0

variable RequestCancelled

const RequestCancelled: integer;

The client has canceled a request and a server as detected the cancel.

variable RequestFailed

const RequestFailed: integer;

A request failed but it was syntactically correct, e.g the method name was known and the parameters were valid. The error message should contain human readable information about why the request failed.
3.17.0

variable ServerCancelled

const ServerCancelled: integer;

The server cancelled the request. This error code should only be used for requests that explicitly support being server cancellable.
3.17.0

namespace MessageType

namespace MessageType {}

The message type

variable Debug

const Debug: number;

A debug message.
3.18.0

variable Error

const Error: number;

An error message.

variable Info

const Info: number;

An information message.

variable Log

const Log: number;

A log message.

variable Warning

const Warning: number;

A warning message.

namespace MonikerKind

namespace MonikerKind {}

The moniker kind.
3.16.0

variable $export

const $export: string;

The moniker represents a symbol that is exported from a project

variable $import

const $import: string;

The moniker represent a symbol that is imported into a project

variable local

const local: string;

The moniker represents a symbol that is local to a project (e.g. a local variable of a function, a class not visible outside the project, ...)

namespace MonikerRequest

namespace MonikerRequest {}

A request to get the moniker of a symbol at a given text document position. The request parameter is of type TextDocumentPositionParams. The response is of type or null.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    MonikerParams,
    Moniker[],
    Moniker[],
    void,
    MonikerRegistrationOptions
>;

namespace NotebookCell

namespace NotebookCell {}

function create

create: (kind: NotebookCellKind, document: DocumentUri) => NotebookCell;

function diff

diff: (one: NotebookCell, two: NotebookCell) => Set<keyof NotebookCell>;

function is

is: (value: any) => value is NotebookCell;

namespace NotebookCellArrayChange

namespace NotebookCellArrayChange {}

function create

create: (
    start: uinteger,
    deleteCount: uinteger,
    cells?: NotebookCell[]
) => NotebookCellArrayChange;

function is

is: (value: any) => value is NotebookCellArrayChange;

namespace NotebookCellKind

namespace NotebookCellKind {}

A notebook cell kind.
3.17.0

variable Code

const Code: number;

A code-cell is source code.

variable Markup

const Markup: number;

A markup-cell is formatted source that is used for display.

function is

is: (value: any) => value is NotebookCellKind;

namespace NotebookCellTextDocumentFilter

namespace NotebookCellTextDocumentFilter {}

The NotebookCellTextDocumentFilter namespace provides helper functions to work with NotebookCellTextDocumentFilter literals.
3.17.0

function is

is: (value: any) => value is NotebookCellTextDocumentFilter;

namespace NotebookDocument

namespace NotebookDocument {}

function create

create: (
    uri: URI,
    notebookType: string,
    version: integer,
    cells: NotebookCell[]
) => NotebookDocument;

function is

is: (value: any) => value is NotebookDocument;

namespace NotebookDocumentFilter

namespace NotebookDocumentFilter {}

The NotebookDocumentFilter namespace provides helper functions to work with NotebookDocumentFilter literals.
3.17.0

function is

is: (value: any) => value is NotebookDocumentFilter;

namespace NotebookDocumentSyncRegistrationType

namespace NotebookDocumentSyncRegistrationType {}

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: RegistrationType<NotebookDocumentSyncRegistrationOptions>;

namespace PositionEncodingKind

namespace PositionEncodingKind {}

A set of predefined position encoding kinds.
3.17.0

variable UTF16

const UTF16: string;

Character offsets count UTF-16 code units.
This is the default and must always be supported by servers

variable UTF32

const UTF32: string;

Character offsets count UTF-32 code units.
Implementation note: these are the same as Unicode codepoints, so this PositionEncodingKind may also be used for an encoding-agnostic representation of character offsets.

variable UTF8

const UTF8: string;

Character offsets count UTF-8 code units (e.g. bytes).

namespace PrepareRenameRequest

namespace PrepareRenameRequest {}

A request to test and perform the setup necessary for a rename.
3.16 - support for default behavior

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<PrepareRenameParams, any, never, void, void>;

namespace PrepareSupportDefaultBehavior

namespace PrepareSupportDefaultBehavior {}

variable Identifier

const Identifier: number;

The client's default behavior is to select the identifier according the to language's syntax rule.

namespace Proposed

namespace Proposed {}

namespace PublishDiagnosticsNotification

namespace PublishDiagnosticsNotification {}

Diagnostics notification are sent from the server to the client to signal results of validation runs.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<PublishDiagnosticsParams, void>;

namespace ReferencesRequest

namespace ReferencesRequest {}

A request to resolve project-wide references for the symbol denoted by the given text document position. The request's parameter is of type ReferenceParams the response is of type or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    ReferenceParams,
    Location[],
    Location[],
    void,
    ReferenceRegistrationOptions
>;

namespace RegistrationRequest

namespace RegistrationRequest {}

The client/registerCapability request is sent from the server to the client to register a new capability handler on the client side.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<RegistrationParams, void, never, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler<RegistrationParams, void, void>;

namespace RelativePattern

namespace RelativePattern {}

function is

is: (value: any) => value is RelativePattern;

namespace RenameRequest

namespace RenameRequest {}

A request to rename a symbol.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    RenameParams,
    any,
    never,
    void,
    RenameRegistrationOptions
>;

namespace ResourceOperationKind

namespace ResourceOperationKind {}

variable Create

const Create: ResourceOperationKind;

Supports creating new files and folders.

variable Delete

const Delete: ResourceOperationKind;

Supports deleting existing files and folders.

variable Rename

const Rename: ResourceOperationKind;

Supports renaming existing files and folders.

namespace SelectionRangeRequest

namespace SelectionRangeRequest {}

A request to provide selection ranges in a document. The request's parameter is of type SelectionRangeParams, the response is of type or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    SelectionRangeParams,
    SelectionRange[],
    SelectionRange[],
    void,
    SelectionRangeRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    SelectionRangeParams,
    SelectionRange[] | null,
    void
>;

namespace SemanticTokensDeltaRequest

namespace SemanticTokensDeltaRequest {}

3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable registrationMethod

const registrationMethod: string;

variable type

const type: ProtocolRequestType<
    SemanticTokensDeltaParams,
    any,
    SemanticTokensPartialResult | SemanticTokensDeltaPartialResult,
    void,
    SemanticTokensRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    SemanticTokensDeltaParams,
    SemanticTokens | SemanticTokensDelta | null,
    void
>;

namespace SemanticTokensRangeRequest

namespace SemanticTokensRangeRequest {}

3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable registrationMethod

const registrationMethod: string;

variable type

const type: ProtocolRequestType<
    SemanticTokensRangeParams,
    any,
    SemanticTokensPartialResult,
    void,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    SemanticTokensRangeParams,
    SemanticTokens | null,
    void
>;

namespace SemanticTokensRefreshRequest

namespace SemanticTokensRefreshRequest {}

3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<void, void, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler0<void, void>;

namespace SemanticTokensRegistrationType

namespace SemanticTokensRegistrationType {}

variable method

const method: string;

variable type

const type: RegistrationType<SemanticTokensRegistrationOptions>;

namespace SemanticTokensRequest

namespace SemanticTokensRequest {}

3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable registrationMethod

const registrationMethod: string;

variable type

const type: ProtocolRequestType<
    SemanticTokensParams,
    any,
    SemanticTokensPartialResult,
    void,
    SemanticTokensRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    SemanticTokensDeltaParams,
    SemanticTokens | null,
    void
>;

namespace ShowDocumentRequest

namespace ShowDocumentRequest {}

A request to show a document. This request might open an external program depending on the value of the URI to open. For example a request to open https://code.visualstudio.com/ will very likely open the URI in a WEB browser.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    ShowDocumentParams,
    ShowDocumentResult,
    void,
    void,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<ShowDocumentParams, ShowDocumentResult, void>;

type MiddlewareSignature

type MiddlewareSignature = (
    params: ShowDocumentParams,
    next: HandlerSignature
) => HandlerResult<ShowDocumentResult, void>;

namespace ShowMessageNotification

namespace ShowMessageNotification {}

The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<ShowMessageParams, void>;

namespace ShowMessageRequest

namespace ShowMessageRequest {}

The show message request is sent from the server to the client to show a message and a set of options actions to the user.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    ShowMessageRequestParams,
    MessageActionItem,
    never,
    void,
    void
>;

namespace ShutdownRequest

namespace ShutdownRequest {}

A shutdown request is sent from the client to the server. It is sent once when the client decides to shutdown the server. The only notification that is sent after a shutdown request is the exit event.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<void, never, void, void>;

namespace SignatureHelpRequest

namespace SignatureHelpRequest {}

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    SignatureHelpParams,
    any,
    never,
    void,
    SignatureHelpRegistrationOptions
>;

namespace SignatureHelpTriggerKind

namespace SignatureHelpTriggerKind {}

How a signature help was triggered.
3.15.0

variable ContentChange

const ContentChange: number;

Signature help was triggered by the cursor moving or by the document content changing.

variable Invoked

const Invoked: number;

Signature help was invoked manually by the user or by a command.

variable TriggerCharacter

const TriggerCharacter: number;

Signature help was triggered by a trigger character.

namespace StaticRegistrationOptions

namespace StaticRegistrationOptions {}

The StaticRegistrationOptions namespace provides helper functions to work with StaticRegistrationOptions literals.

function hasId

hasId: (value: object) => value is { id: string };

namespace TelemetryEventNotification

namespace TelemetryEventNotification {}

The telemetry event notification is sent from the server to the client to ask the client to log telemetry data.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<any, void>;

namespace TextDocumentContentChangeEvent

namespace TextDocumentContentChangeEvent {}

function isFull

isFull: (event: TextDocumentContentChangeEvent) => event is { text: string };

Checks whether the information describes a full replacement event.

function isIncremental

isIncremental: (
    event: TextDocumentContentChangeEvent
) => event is { range: Range; rangeLength?: uinteger; text: string };

Checks whether the information describes a delta event.

namespace TextDocumentFilter

namespace TextDocumentFilter {}

The TextDocumentFilter namespace provides helper functions to work with TextDocumentFilter literals.
3.17.0

function is

is: (value: any) => value is TextDocumentFilter;

namespace TextDocumentRegistrationOptions

namespace TextDocumentRegistrationOptions {}

The TextDocumentRegistrationOptions namespace provides helper functions to work with TextDocumentRegistrationOptions literals.

function is

is: (value: any) => value is TextDocumentRegistrationOptions;

namespace TextDocumentSaveReason

namespace TextDocumentSaveReason {}

Represents reasons why a text document is saved.

variable AfterDelay

const AfterDelay: number;

Automatic after a delay.

variable FocusOut

const FocusOut: number;

When the editor lost focus.

variable Manual

const Manual: number;

Manually triggered, e.g. by the user pressing save, by starting debugging, or by an API call.

namespace TextDocumentSyncKind

namespace TextDocumentSyncKind {}

Defines how the host (editor) should sync document changes to the language server.

variable Full

const Full: number;

Documents are synced by always sending the full content of the document.

variable Incremental

const Incremental: number;

Documents are synced by sending the full content on open. After that only incremental updates to the document are send.

variable None

const None: number;

Documents should not be synced at all.

namespace TokenFormat

namespace TokenFormat {}

variable Relative

const Relative: string;

namespace TypeDefinitionRequest

namespace TypeDefinitionRequest {}

A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type TextDocumentPositionParams the response is of type Definition or a Thenable that resolves to such.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    TypeDefinitionParams,
    any,
    LocationLink[] | Location[],
    void,
    TypeDefinitionRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    TypeDefinitionParams,
    Definition | DefinitionLink[] | null,
    void
>;

namespace TypeHierarchyPrepareRequest

namespace TypeHierarchyPrepareRequest {}

A request to result a TypeHierarchyItem in a document at a given position. Can be used as an input to a subtypes or supertypes type hierarchy.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    TypeHierarchyPrepareParams,
    TypeHierarchyItem[],
    never,
    void,
    TypeHierarchyRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    TypeHierarchyPrepareParams,
    TypeHierarchyItem[] | null,
    void
>;

namespace TypeHierarchySubtypesRequest

namespace TypeHierarchySubtypesRequest {}

A request to resolve the subtypes for a given TypeHierarchyItem.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    TypeHierarchySubtypesParams,
    TypeHierarchyItem[],
    TypeHierarchyItem[],
    void,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    TypeHierarchySubtypesParams,
    TypeHierarchyItem[] | null,
    void
>;

namespace TypeHierarchySupertypesRequest

namespace TypeHierarchySupertypesRequest {}

A request to resolve the supertypes for a given TypeHierarchyItem.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    TypeHierarchySupertypesParams,
    TypeHierarchyItem[],
    TypeHierarchyItem[],
    void,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    TypeHierarchySupertypesParams,
    TypeHierarchyItem[] | null,
    void
>;

namespace UniquenessLevel

namespace UniquenessLevel {}

Moniker uniqueness level to define scope of the moniker.
3.16.0

variable document

const document: string;

The moniker is only unique inside a document

variable global

const global: string;

The moniker is globally unique

variable group

const group: string;

The moniker is unique inside the group to which a project belongs

variable project

const project: string;

The moniker is unique inside a project for which a dump got created

variable scheme

const scheme: string;

The moniker is unique inside the moniker scheme.

namespace UnregistrationRequest

namespace UnregistrationRequest {}

The client/unregisterCapability request is sent from the server to the client to unregister a previously registered capability handler on the client side.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<UnregistrationParams, void, never, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler<UnregistrationParams, void, void>;

namespace WatchKind

namespace WatchKind {}

variable Change

const Change: number;

Interested in change events

variable Create

const Create: number;

Interested in create events.

variable Delete

const Delete: number;

Interested in delete events

namespace WillCreateFilesRequest

namespace WillCreateFilesRequest {}

The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client.
The request can return a WorkspaceEdit which will be applied to workspace before the files are created. Hence the WorkspaceEdit can not manipulate the content of the file to be created.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    CreateFilesParams,
    any,
    never,
    void,
    FileOperationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    CreateFilesParams,
    WorkspaceEdit | undefined | null,
    void
>;

namespace WillDeleteFilesRequest

namespace WillDeleteFilesRequest {}

The did delete files notification is sent from the client to the server when files were deleted from within the client.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    DeleteFilesParams,
    any,
    never,
    void,
    FileOperationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    DeleteFilesParams,
    WorkspaceEdit | undefined | null,
    void
>;

namespace WillRenameFilesRequest

namespace WillRenameFilesRequest {}

The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client.
3.16.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    RenameFilesParams,
    any,
    never,
    void,
    FileOperationRegistrationOptions
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    RenameFilesParams,
    WorkspaceEdit | undefined | null,
    void
>;

namespace WillSaveTextDocumentNotification

namespace WillSaveTextDocumentNotification {}

A document will save notification is sent from the client to the server before the document is actually saved.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<
    WillSaveTextDocumentParams,
    TextDocumentRegistrationOptions
>;

namespace WillSaveTextDocumentWaitUntilRequest

namespace WillSaveTextDocumentWaitUntilRequest {}

A document will save request is sent from the client to the server before the document is actually saved. The request can return an array of TextEdits which will be applied to the text document before it is saved. Please note that clients might drop results if computing the text edits took too long or if a server constantly fails on this request. This is done to keep the save fast and reliable.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    WillSaveTextDocumentParams,
    TextEdit[],
    never,
    void,
    TextDocumentRegistrationOptions
>;

namespace WorkDoneProgress

namespace WorkDoneProgress {}

variable type

const type: ProgressType<
    WorkDoneProgressBegin | WorkDoneProgressReport | WorkDoneProgressEnd
>;

function is

is: (
    value: ProgressType<any>
) => value is ProgressType<
    WorkDoneProgressBegin | WorkDoneProgressReport | WorkDoneProgressEnd
>;

namespace WorkDoneProgressCancelNotification

namespace WorkDoneProgressCancelNotification {}

The window/workDoneProgress/cancel notification is sent from the client to the server to cancel a progress initiated on the server side.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolNotificationType<WorkDoneProgressCancelParams, void>;

type HandlerSignature

type HandlerSignature = NotificationHandler<WorkDoneProgressCancelParams>;

namespace WorkDoneProgressCreateRequest

namespace WorkDoneProgressCreateRequest {}

The window/workDoneProgress/create request is sent from the server to the client to initiate progress reporting from the server.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    WorkDoneProgressCreateParams,
    void,
    never,
    void,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<WorkDoneProgressCreateParams, void, void>;

namespace WorkDoneProgressOptions

namespace WorkDoneProgressOptions {}

The WorkDoneProgressOptions namespace provides helper functions to work with WorkDoneProgressOptions literals.

function hasWorkDoneProgress

hasWorkDoneProgress: (value: any) => value is { workDoneProgress: boolean };

function is

is: (value: any) => value is WorkDoneProgressOptions;

namespace WorkspaceDiagnosticRequest

namespace WorkspaceDiagnosticRequest {}

The workspace diagnostic request definition.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable partialResult

const partialResult: ProgressType<WorkspaceDiagnosticReportPartialResult>;

variable type

const type: ProtocolRequestType<
    WorkspaceDiagnosticParams,
    WorkspaceDiagnosticReport,
    WorkspaceDiagnosticReportPartialResult,
    DiagnosticServerCancellationData,
    void
>;

type HandlerSignature

type HandlerSignature = RequestHandler<
    WorkspaceDiagnosticParams,
    WorkspaceDiagnosticReport | null,
    void
>;

namespace WorkspaceFoldersRequest

namespace WorkspaceFoldersRequest {}

The workspace/workspaceFolders is sent from the server to the client to fetch the open workspace folders.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType0<WorkspaceFolder[], never, void, void>;

type HandlerSignature

type HandlerSignature = RequestHandler0<WorkspaceFolder[] | null, void>;

type MiddlewareSignature

type MiddlewareSignature = (
    token: CancellationToken,
    next: HandlerSignature
) => HandlerResult<WorkspaceFolder[] | null, void>;

namespace WorkspaceSymbolRequest

namespace WorkspaceSymbolRequest {}

A request to list project-wide symbols matching the query string given by the WorkspaceSymbolParams. The response is of type or a Thenable that resolves to such.
3.17.0 - support for WorkspaceSymbol in the returned data. Clients need to advertise support for WorkspaceSymbols via the client capability workspace.symbol.resolveSupport.

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<
    WorkspaceSymbolParams,
    SymbolInformation[] | WorkspaceSymbol[],
    SymbolInformation[] | WorkspaceSymbol[],
    void,
    WorkspaceSymbolRegistrationOptions
>;

namespace WorkspaceSymbolResolveRequest

namespace WorkspaceSymbolResolveRequest {}

A request to resolve the range inside the workspace symbol's location.
3.17.0

variable messageDirection

const messageDirection: MessageDirection;

variable method

const method: string;

variable type

const type: ProtocolRequestType<WorkspaceSymbol, WorkspaceSymbol, never, void, void>;

Package Files (25)

Dependencies (2)

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/vscode-languageserver-protocol.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/vscode-languageserver-protocol)

HTML

<a href="https://www.jsdocs.io/package/vscode-languageserver-protocol"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 year ago.
Package analyzed in 7360 ms.
Missing or incorrect documentation? Open an issue for this package.