Class LanguageClient

Hierarchy (View Summary)

BaseLanguageClient
- LanguageClient

Constructors

constructor

new LanguageClient(
    name: string,
    serverOptions: ServerOptions,
    clientOptions: LanguageClientOptions,
    forceDebug?: boolean,
): LanguageClient
Parameters
- name: string
  Human-readable name used in messages and as the title of the output channel.
  
  Also the id of BaseLanguageClient (after lowercasing), which is:
  1. Used to find tracing settings in VSCode configuration:
    
    trace.server (string or object),
    
    trace.server.verbosity
    
    trace.server.format
  2. Used as the default diagnostic collection name.
- serverOptions: ServerOptions
- clientOptions: LanguageClientOptions
- OptionalforceDebug: boolean
  Defaults to false.
Returns LanguageClient
Overrides BaseLanguageClient.constructor
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:153
new LanguageClient(
    id: string,
    name: string,
    serverOptions: ServerOptions,
    clientOptions: LanguageClientOptions,
    forceDebug?: boolean,
): LanguageClient
Parameters
- id: string
  1. Used to find tracing settings in VSCode configuration:
    
    trace.server (string or object),
    
    trace.server.verbosity
    
    trace.server.format
  2. Used as the default diagnostic collection name.
- name: string
  Human-readable name used in messages and as the title of the output channel.
- serverOptions: ServerOptions
- clientOptions: LanguageClientOptions
- OptionalforceDebug: boolean
  Defaults to false.
Returns LanguageClient
Overrides BaseLanguageClient.constructor
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:170

Accessors

clientOptions

get clientOptions(): LanguageClientOptions
Returns LanguageClientOptions
Inherited from BaseLanguageClient.clientOptions
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:807

code2ProtocolConverter

get code2ProtocolConverter(): Code2ProtocolConverter
Returns Code2ProtocolConverter
Inherited from BaseLanguageClient.code2ProtocolConverter
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:815

diagnostics

get diagnostics(): undefined | DiagnosticCollection
Returns undefined | DiagnosticCollection
Inherited from BaseLanguageClient.diagnostics
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:848

initializeResult

get initializeResult(): undefined | InitializeResult
Returns undefined | InitializeResult
Inherited from BaseLanguageClient.initializeResult
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:882

isInDebugMode

get isInDebugMode(): boolean
Returns boolean
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:219

middleware

get middleware(): Middleware
Returns Middleware
Inherited from BaseLanguageClient.middleware
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:803

name

get name(): string
Returns string
Inherited from BaseLanguageClient.name
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:799

onDidChangeState

get onDidChangeState(): Event<StateChangeEvent>
Returns Event<StateChangeEvent>
Inherited from BaseLanguageClient.onDidChangeState
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:830

onTelemetry

get onTelemetry(): Event<any>
Returns Event<any>
Inherited from BaseLanguageClient.onTelemetry
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:826

outputChannel

get outputChannel(): OutputChannel
Returns OutputChannel
Inherited from BaseLanguageClient.outputChannel
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:834

traceOutputChannel

get traceOutputChannel(): OutputChannel
Returns OutputChannel
Inherited from BaseLanguageClient.traceOutputChannel
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:841

Methods

createDefaultErrorHandler

createDefaultErrorHandler(maxRestartCount?: number): ErrorHandler
Parameters
- OptionalmaxRestartCount: number
Returns ErrorHandler
Inherited from BaseLanguageClient.createDefaultErrorHandler
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1142

`Protected`createMessageTransports

createMessageTransports(encoding: string): Promise<MessageTransports>
Parameters
- encoding: string
Returns Promise<MessageTransports>
Overrides BaseLanguageClient.createMessageTransports
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:279

debug

debug(message: string, data?: any, showNotification?: boolean): void
Parameters
- message: string
- Optionaldata: any
- showNotification: boolean = true
Returns void
Inherited from BaseLanguageClient.debug
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1177

dispose

dispose(timeout?: number): Promise<void>
Parameters
- timeout: number = 2000
Returns Promise<void>
Inherited from BaseLanguageClient.dispose
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1550

error

error(message: string, data?: any, showNotification?: boolean | "force"): void
Parameters
- message: string
- Optionaldata: any
- showNotification: boolean | "force" = true
Returns void
Inherited from BaseLanguageClient.error
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1189

`Protected`fillInitializeParams

fillInitializeParams(params: InitializeParams): void
Parameters
- params: InitializeParams
Returns void
Overrides BaseLanguageClient.fillInitializeParams
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:272

getFeature

getFeature(request: "textDocument/didOpen"): DidOpenTextDocumentFeatureShape
Parameters
- request: "textDocument/didOpen"
Returns DidOpenTextDocumentFeatureShape
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1912
getFeature(request: "textDocument/didChange"): DidChangeTextDocumentFeatureShape
Parameters
- request: "textDocument/didChange"
Returns DidChangeTextDocumentFeatureShape
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1913
getFeature(
request: "textDocument/willSave",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature<
(textDocument: TextDocument) => Promise<void>,
>
Parameters
- request: "textDocument/willSave"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature<
(textDocument: TextDocument) => Promise<void>,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1914
getFeature(
request: "textDocument/willSaveWaitUntil",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature<
(textDocument: TextDocument) => ProviderResult<TextEdit[]>,
>
Parameters
- request: "textDocument/willSaveWaitUntil"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature<
(textDocument: TextDocument) => ProviderResult<TextEdit[]>,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1915
getFeature(request: "textDocument/didSave"): DidSaveTextDocumentFeatureShape
Parameters
- request: "textDocument/didSave"
Returns DidSaveTextDocumentFeatureShape
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1916
getFeature(request: "textDocument/didClose"): DidCloseTextDocumentFeatureShape
Parameters
- request: "textDocument/didClose"
Returns DidCloseTextDocumentFeatureShape
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1917
getFeature(
request: "workspace/didCreateFiles",
): DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileCreateEvent) => Promise<void>;
}
Parameters
- request: "workspace/didCreateFiles"
Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileCreateEvent) => Promise<void>;
}
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1918
getFeature(
request: "workspace/didRenameFiles",
): DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileRenameEvent) => Promise<void>;
}
Parameters
- request: "workspace/didRenameFiles"
Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileRenameEvent) => Promise<void>;
}
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1919
getFeature(
request: "workspace/didDeleteFiles",
): DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileDeleteEvent) => Promise<void>;
}
Parameters
- request: "workspace/didDeleteFiles"
Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileDeleteEvent) => Promise<void>;
}
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1920
getFeature(
request: "workspace/willCreateFiles",
): DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillCreateEvent) => Promise<void>;
}
Parameters
- request: "workspace/willCreateFiles"
Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillCreateEvent) => Promise<void>;
}
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1921
getFeature(
request: "workspace/willRenameFiles",
): DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillRenameEvent) => Promise<void>;
}
Parameters
- request: "workspace/willRenameFiles"
Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillRenameEvent) => Promise<void>;
}
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1922
getFeature(
request: "workspace/willDeleteFiles",
): DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillDeleteEvent) => Promise<void>;
}
Parameters
- request: "workspace/willDeleteFiles"
Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillDeleteEvent) => Promise<void>;
}
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1923
getFeature(
request: "textDocument/completion",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CompletionItemProvider,
>
Parameters
- request: "textDocument/completion"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CompletionItemProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1924
getFeature(
request: "textDocument/hover",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
HoverProvider,
>
Parameters
- request: "textDocument/hover"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
HoverProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1925
getFeature(
request: "textDocument/signatureHelp",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SignatureHelpProvider,
>
Parameters
- request: "textDocument/signatureHelp"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SignatureHelpProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1926
getFeature(
request: "textDocument/definition",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DefinitionProvider,
>
Parameters
- request: "textDocument/definition"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DefinitionProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1927
getFeature(
request: "textDocument/references",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
ReferenceProvider,
>
Parameters
- request: "textDocument/references"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
ReferenceProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1928
getFeature(
request: "textDocument/documentHighlight",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentHighlightProvider,
>
Parameters
- request: "textDocument/documentHighlight"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentHighlightProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1929
getFeature(
request: "textDocument/codeAction",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CodeActionProvider,
>
Parameters
- request: "textDocument/codeAction"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CodeActionProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1930
getFeature(
request: "textDocument/codeLens",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CodeLensProviderShape,
>
Parameters
- request: "textDocument/codeLens"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CodeLensProviderShape,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1931
getFeature(
request: "textDocument/formatting",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentFormattingEditProvider,
>
Parameters
- request: "textDocument/formatting"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentFormattingEditProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1932
getFeature(
request: "textDocument/rangeFormatting",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentRangeFormattingEditProvider,
>
Parameters
- request: "textDocument/rangeFormatting"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentRangeFormattingEditProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1933
getFeature(
request: "textDocument/onTypeFormatting",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
OnTypeFormattingEditProvider,
>
Parameters
- request: "textDocument/onTypeFormatting"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
OnTypeFormattingEditProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1934
getFeature(
request: "textDocument/rename",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
RenameProvider,
>
Parameters
- request: "textDocument/rename"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
RenameProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1935
getFeature(
request: "textDocument/documentSymbol",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentSymbolProvider,
>
Parameters
- request: "textDocument/documentSymbol"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentSymbolProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1936
getFeature(
request: "textDocument/documentLink",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentLinkProvider,
>
Parameters
- request: "textDocument/documentLink"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentLinkProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1937
getFeature(
request: "textDocument/documentColor",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentColorProvider,
>
Parameters
- request: "textDocument/documentColor"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentColorProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1938
getFeature(
request: "textDocument/declaration",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DeclarationProvider,
>
Parameters
- request: "textDocument/declaration"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DeclarationProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1939
getFeature(
request: "textDocument/foldingRange",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
FoldingRangeProviderShape,
>
Parameters
- request: "textDocument/foldingRange"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
FoldingRangeProviderShape,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1940
getFeature(
request: "textDocument/implementation",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
ImplementationProvider,
>
Parameters
- request: "textDocument/implementation"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
ImplementationProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1941
getFeature(
request: "textDocument/selectionRange",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SelectionRangeProvider,
>
Parameters
- request: "textDocument/selectionRange"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SelectionRangeProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1942
getFeature(
request: "textDocument/typeDefinition",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
TypeDefinitionProvider,
>
Parameters
- request: "textDocument/typeDefinition"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
TypeDefinitionProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1943
getFeature(
request: "textDocument/prepareCallHierarchy",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CallHierarchyProvider,
>
Parameters
- request: "textDocument/prepareCallHierarchy"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CallHierarchyProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1944
getFeature(
request: "textDocument/semanticTokens",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SemanticTokensProviderShape,
>
Parameters
- request: "textDocument/semanticTokens"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SemanticTokensProviderShape,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1945
getFeature(
request: "textDocument/linkedEditingRange",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
LinkedEditingRangeProvider,
>
Parameters
- request: "textDocument/linkedEditingRange"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
LinkedEditingRangeProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1946
getFeature(
request: "textDocument/prepareTypeHierarchy",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
TypeHierarchyProvider,
>
Parameters
- request: "textDocument/prepareTypeHierarchy"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
TypeHierarchyProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1947
getFeature(
request: "textDocument/inlineValue",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
InlineValueProviderShape,
>
Parameters
- request: "textDocument/inlineValue"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
InlineValueProviderShape,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1948
getFeature(
request: "textDocument/inlayHint",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
InlayHintsProviderShape,
>
Parameters
- request: "textDocument/inlayHint"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
InlayHintsProviderShape,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1949
getFeature(
request: "workspace/symbol",
): DynamicFeature<TextDocumentRegistrationOptions> & WorkspaceProviderFeature<
WorkspaceSymbolProvider,
>
Parameters
- request: "workspace/symbol"
Returns DynamicFeature<TextDocumentRegistrationOptions> & WorkspaceProviderFeature<
WorkspaceSymbolProvider,
>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1950
getFeature(
request: "textDocument/diagnostic",
): DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DiagnosticProviderShape,
> & DiagnosticFeatureShape
Parameters
- request: "textDocument/diagnostic"
Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DiagnosticProviderShape,
> & DiagnosticFeatureShape
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1951
getFeature(
request: "notebookDocument/sync",
): DynamicFeature<NotebookDocumentSyncRegistrationOptions> & NotebookDocumentProviderShape
Parameters
- request: "notebookDocument/sync"
Returns DynamicFeature<NotebookDocumentSyncRegistrationOptions> & NotebookDocumentProviderShape
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1952
getFeature(
 request: "textDocument/inlineCompletion",
):
 | undefined
 | DynamicFeature<InlineCompletionRegistrationOptions> & TextDocumentProviderFeature<
 InlineCompletionItemProvider,
 >
Parameters
- request: "textDocument/inlineCompletion"
Returns
 | undefined
 | DynamicFeature<InlineCompletionRegistrationOptions> & TextDocumentProviderFeature<
 InlineCompletionItemProvider,
 >
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1953
getFeature(
 request: "workspace/textDocumentContent",
):
 | undefined
 | DynamicFeature<TextDocumentRegistrationOptions> & WorkspaceProviderFeature<
 TextDocumentContentProviderShape,
 >
Parameters
- request: "workspace/textDocumentContent"
Returns
 | undefined
 | DynamicFeature<TextDocumentRegistrationOptions> & WorkspaceProviderFeature<
 TextDocumentContentProviderShape,
 >
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1954
getFeature(
request: "workspace/executeCommand",
): DynamicFeature<ExecuteCommandOptions>
Parameters
- request: "workspace/executeCommand"
Returns DynamicFeature<ExecuteCommandOptions>
Inherited from BaseLanguageClient.getFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1955

`Protected`getLocale

getLocale(): string
Returns string
Inherited from BaseLanguageClient.getLocale
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1763

`Protected`handleConnectionClosed

handleConnectionClosed(): Promise<void>
Returns Promise<void>
Overrides BaseLanguageClient.handleConnectionClosed
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:267

handleFailedRequest

handleFailedRequest<T>(
 type: MessageSignature,
 token: undefined | CancellationToken,
 error: any,
 defaultValue: T,
 showNotification?: boolean,
 throwOnCancel?: boolean,
): T
Type Parameters
- T
Parameters
- type: MessageSignature
- token: undefined | CancellationToken
- error: any
- defaultValue: T
- showNotification: boolean = true
- throwOnCancel: boolean = false
Returns T
Inherited from BaseLanguageClient.handleFailedRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:2229

hasDedicatedTextSynchronizationFeature

hasDedicatedTextSynchronizationFeature(textDocument: TextDocument): boolean
Parameters
- textDocument: TextDocument
Returns boolean
Inherited from BaseLanguageClient.hasDedicatedTextSynchronizationFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1960

info

info(message: string, data?: any, showNotification?: boolean): void
Parameters
- message: string
- Optionaldata: any
- showNotification: boolean = true
Returns void
Inherited from BaseLanguageClient.info
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1181

isRunning

isRunning(): boolean
Returns boolean
Inherited from BaseLanguageClient.isRunning
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1250

needsStart

needsStart(): boolean
Returns boolean
Inherited from BaseLanguageClient.needsStart
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1238

needsStop

needsStop(): boolean
Returns boolean
Inherited from BaseLanguageClient.needsStop
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1242

onNotification

onNotification<RO>(
type: ProtocolNotificationType0<RO>,
handler: NotificationHandler0,
): Disposable
Type Parameters
- RO
Parameters
- type: ProtocolNotificationType0<RO>
- handler: NotificationHandler0
Returns Disposable
Inherited from BaseLanguageClient.onNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1044
onNotification<P, RO>(
type: ProtocolNotificationType<P, RO>,
handler: NotificationHandler,
): Disposable
Type Parameters
- P
- RO
Parameters
- type: ProtocolNotificationType<P, RO>
- handler: NotificationHandler
Returns Disposable
Inherited from BaseLanguageClient.onNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1045
onNotification(
type: NotificationType0,
handler: NotificationHandler0,
): Disposable
Parameters
- type: NotificationType0
- handler: NotificationHandler0
Returns Disposable
Inherited from BaseLanguageClient.onNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1046
onNotification(
type: NotificationType,
handler: NotificationHandler,
): Disposable
Type Parameters
- P
Parameters
- type: NotificationType
- handler: NotificationHandler
Returns Disposable
Inherited from BaseLanguageClient.onNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1047
onNotification(method: string, handler: GenericNotificationHandler): Disposable
Parameters
- method: string
- handler: GenericNotificationHandler
Returns Disposable
Inherited from BaseLanguageClient.onNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1048

onProgress

onProgress(
 type: ProgressType,
 token: string | number,
 handler: NotificationHandler,
): Disposable
Type Parameters
- P
Parameters
- type: ProgressType
- token: string | number
- handler: NotificationHandler
Returns Disposable
Inherited from BaseLanguageClient.onProgress
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1100

onRequest

onRequest<R, PR, E, RO>(
type: ProtocolRequestType0<R, PR, E, RO>,
handler: RequestHandler0<R, E>,
): Disposable
Type Parameters
- R
- PR
- E
- RO
Parameters
- type: ProtocolRequestType0<R, PR, E, RO>
- handler: RequestHandler0<R, E>
Returns Disposable
Inherited from BaseLanguageClient.onRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:950
onRequest<P, R, PR, E, RO>(
type: ProtocolRequestType<P, R, PR, E, RO>,
handler: RequestHandler<P, R, E>,
): Disposable
Type Parameters
- P
- R
- PR
- E
- RO
Parameters
- type: ProtocolRequestType<P, R, PR, E, RO>
- handler: RequestHandler<P, R, E>
Returns Disposable
Inherited from BaseLanguageClient.onRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:951
onRequest<R, E>(
type: RequestType0<R, E>,
handler: RequestHandler0<R, E>,
): Disposable
Type Parameters
- R
- E
Parameters
- type: RequestType0<R, E>
- handler: RequestHandler0<R, E>
Returns Disposable
Inherited from BaseLanguageClient.onRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:952
onRequest<P, R, E>(
type: RequestType<P, R, E>,
handler: RequestHandler<P, R, E>,
): Disposable
Type Parameters
- P
- R
- E
Parameters
- type: RequestType<P, R, E>
- handler: RequestHandler<P, R, E>
Returns Disposable
Inherited from BaseLanguageClient.onRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:953
onRequest<R, E>(
method: string,
handler: GenericRequestHandler<R, E>,
): Disposable
Type Parameters
- R
- E
Parameters
- method: string
- handler: GenericRequestHandler<R, E>
Returns Disposable
Inherited from BaseLanguageClient.onRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:954

`Protected`registerBuiltinFeatures

registerBuiltinFeatures(): void
Returns void
Inherited from BaseLanguageClient.registerBuiltinFeatures
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1968

registerFeature

registerFeature(feature: StaticFeature | DynamicFeature<any>): void
Parameters
- feature: StaticFeature | DynamicFeature<any>
Returns void
Inherited from BaseLanguageClient.registerFeature
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1904

registerFeatures

registerFeatures(features: (StaticFeature | DynamicFeature<any>)[]): void
Parameters
- features: (StaticFeature | DynamicFeature<any>)[]
Returns void
Inherited from BaseLanguageClient.registerFeatures
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1898

registerProposedFeatures

registerProposedFeatures(): void
Returns void
Inherited from BaseLanguageClient.registerProposedFeatures
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:2028

restart

restart(): Promise<void>
Returns Promise<void>
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:223

sendNotification

sendNotification<RO>(type: ProtocolNotificationType0<RO>): Promise<void>
Type Parameters
- RO
Parameters
- type: ProtocolNotificationType0<RO>
Returns Promise<void>
Inherited from BaseLanguageClient.sendNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:992
sendNotification<P, RO>(
type: ProtocolNotificationType<P, RO>,
params?: P,
): Promise<void>
Type Parameters
- P
- RO
Parameters
- type: ProtocolNotificationType<P, RO>
- Optionalparams: P
Returns Promise<void>
Inherited from BaseLanguageClient.sendNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:993
sendNotification(type: NotificationType0): Promise<void>
Parameters
- type: NotificationType0
Returns Promise<void>
Inherited from BaseLanguageClient.sendNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:994
sendNotification(type: NotificationType, params?: P): Promise<void>
Type Parameters
- P
Parameters
- type: NotificationType
- Optionalparams: P
Returns Promise<void>
Inherited from BaseLanguageClient.sendNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:995
sendNotification(method: string): Promise<void>
Parameters
- method: string
Returns Promise<void>
Inherited from BaseLanguageClient.sendNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:996
sendNotification(method: string, params: any): Promise<void>
Parameters
- method: string
- params: any
Returns Promise<void>
Inherited from BaseLanguageClient.sendNotification
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:997

sendProgress

sendProgress(
 type: ProgressType,
 token: string | number,
 value: P,
): Promise<void>
Type Parameters
- P
Parameters
- type: ProgressType
- token: string | number
- value: P
Returns Promise<void>
Inherited from BaseLanguageClient.sendProgress
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1086

sendRequest

sendRequest<R, PR, E, RO>(
type: ProtocolRequestType0<R, PR, E, RO>,
token?: CancellationToken,
): Promise<R>
Type Parameters
- R
- PR
- E
- RO
Parameters
- type: ProtocolRequestType0<R, PR, E, RO>
- Optionaltoken: CancellationToken
Returns Promise<R>
Inherited from BaseLanguageClient.sendRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:886
sendRequest<P, R, PR, E, RO>(
 type: ProtocolRequestType<P, R, PR, E, RO>,
 params: P,
 token?: CancellationToken,
): Promise<R>
Type Parameters
- P
- R
- PR
- E
- RO
Parameters
- type: ProtocolRequestType<P, R, PR, E, RO>
- params: P
- Optionaltoken: CancellationToken
Returns Promise<R>
Inherited from BaseLanguageClient.sendRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:887
sendRequest<R, E>(
type: RequestType0<R, E>,
token?: CancellationToken,
): Promise<R>
Type Parameters
- R
- E
Parameters
- type: RequestType0<R, E>
- Optionaltoken: CancellationToken
Returns Promise<R>
Inherited from BaseLanguageClient.sendRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:888
sendRequest<P, R, E>(
 type: RequestType<P, R, E>,
 params: P,
 token?: CancellationToken,
): Promise<R>
Type Parameters
- P
- R
- E
Parameters
- type: RequestType<P, R, E>
- params: P
- Optionaltoken: CancellationToken
Returns Promise<R>
Inherited from BaseLanguageClient.sendRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:889
sendRequest<R>(method: string, token?: CancellationToken): Promise<R>
Type Parameters
- R
Parameters
- method: string
- Optionaltoken: CancellationToken
Returns Promise<R>
Inherited from BaseLanguageClient.sendRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:890
sendRequest<R>(
 method: string,
 param: any,
 token?: CancellationToken,
): Promise<R>
Type Parameters
- R
Parameters
- method: string
- param: any
- Optionaltoken: CancellationToken
Returns Promise<R>
Inherited from BaseLanguageClient.sendRequest
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:891

setTrace

setTrace(value: Trace): Promise<void>
Parameters
- value: Trace
Returns Promise<void>
Inherited from BaseLanguageClient.setTrace
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1149

`Protected`shutdown

shutdown(mode: ShutdownMode, timeout?: number): Promise<void>
Parameters
- mode: ShutdownMode
- timeout: number = 2000
Returns Promise<void>
Overrides BaseLanguageClient.shutdown
- Defined in projects/vscode-languageserver-node/client/src/node/main.ts:237

start

start(): Promise<void>
Returns Promise<void>
Inherited from BaseLanguageClient.start
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1254

stop

stop(timeout?: number): Promise<void>
Parameters
- timeout: number = 2000
Returns Promise<void>
Inherited from BaseLanguageClient.stop
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1545

warn

warn(message: string, data?: any, showNotification?: boolean): void
Parameters
- message: string
- Optionaldata: any
- showNotification: boolean = true
Returns void
Inherited from BaseLanguageClient.warn
- Defined in projects/vscode-languageserver-node/client/src/common/client.ts:1185

Class LanguageClient

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns LanguageClient

Parameters

Returns LanguageClient

Accessors

clientOptions

Returns LanguageClientOptions

code2ProtocolConverter

Returns Code2ProtocolConverter

diagnostics

Returns undefined | DiagnosticCollection

initializeResult

Returns undefined | InitializeResult

isInDebugMode

Returns boolean

middleware

Returns Middleware

name

Returns string

onDidChangeState

Returns Event<StateChangeEvent>

onTelemetry

Returns Event<any>

outputChannel

Returns OutputChannel

protocol2CodeConverter

Returns Protocol2CodeConverter

state

Returns State

tabsModel

Returns TabsModel

traceOutputChannel

Returns OutputChannel

Methods

createDefaultErrorHandler

Parameters

Returns ErrorHandler

ProtectedcreateMessageTransports

Parameters

Returns Promise<MessageTransports>

debug

Parameters

Returns void

dispose

Parameters

Returns Promise<void>

error

Parameters

Returns void

ProtectedfillInitializeParams

Parameters

Returns void

getFeature

Parameters

Returns DidOpenTextDocumentFeatureShape

Parameters

Returns DidChangeTextDocumentFeatureShape

Parameters

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature< (textDocument: TextDocument) => Promise<void>,>

Parameters

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature< (textDocument: TextDocument) => ProviderResult<TextEdit[]>,>

Parameters

Returns DidSaveTextDocumentFeatureShape

Parameters

Returns DidCloseTextDocumentFeatureShape

Parameters

Returns DynamicFeature<FileOperationRegistrationOptions> & { send: (event: FileCreateEvent) => Promise<void>;}

Parameters

Returns DynamicFeature<FileOperationRegistrationOptions> & { send: (event: FileRenameEvent) => Promise<void>;}

Parameters

Returns DynamicFeature<FileOperationRegistrationOptions> & { send: (event: FileDeleteEvent) => Promise<void>;}

Parameters

`Protected`createMessageTransports

`Protected`fillInitializeParams

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature<
(textDocument: TextDocument) => Promise<void>,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentSendFeature<
(textDocument: TextDocument) => ProviderResult<TextEdit[]>,
>

Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileCreateEvent) => Promise<void>;
}

Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileRenameEvent) => Promise<void>;
}

Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileDeleteEvent) => Promise<void>;
}

Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillCreateEvent) => Promise<void>;
}

Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillRenameEvent) => Promise<void>;
}

Returns DynamicFeature<FileOperationRegistrationOptions> & {
send: (event: FileWillDeleteEvent) => Promise<void>;
}

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CompletionItemProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
HoverProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SignatureHelpProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DefinitionProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
ReferenceProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentHighlightProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CodeActionProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CodeLensProviderShape,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentFormattingEditProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentRangeFormattingEditProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
OnTypeFormattingEditProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
RenameProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentSymbolProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentLinkProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DocumentColorProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DeclarationProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
FoldingRangeProviderShape,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
ImplementationProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SelectionRangeProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
TypeDefinitionProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
CallHierarchyProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
SemanticTokensProviderShape,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
LinkedEditingRangeProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
TypeHierarchyProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
InlineValueProviderShape,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
InlayHintsProviderShape,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & WorkspaceProviderFeature<
WorkspaceSymbolProvider,
>

Returns DynamicFeature<TextDocumentRegistrationOptions> & TextDocumentProviderFeature<
DiagnosticProviderShape,
> & DiagnosticFeatureShape

Returns
| undefined
| DynamicFeature<InlineCompletionRegistrationOptions> & TextDocumentProviderFeature<
InlineCompletionItemProvider,
>

Returns
| undefined
| DynamicFeature<TextDocumentRegistrationOptions> & WorkspaceProviderFeature<
TextDocumentContentProviderShape,
>

`Protected`getLocale