Interface _InitializeParams

The initialize parameters

interface _InitializeParams {
    capabilities: ClientCapabilities;
    clientInfo?: ClientInfo;
    initializationOptions?: any;
    locale?: string;
    processId: null | number;
    rootPath?: null | string;
    rootUri: null | string;
    trace?: TraceValue;
    workDoneToken?: ProgressToken;
}

Hierarchy (View Summary)

Properties

capabilities clientInfo? initializationOptions? locale? processId rootPath? rootUri trace? workDoneToken?

Properties

capabilities

capabilities: ClientCapabilities

The capabilities provided by the client (editor or tool)

OptionalclientInfo

clientInfo?: ClientInfo

Information about the client

Since

3.15.0

OptionalinitializationOptions

initializationOptions?: any

User provided initialization options.

Optionallocale

locale?: string

The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.

Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag)

Since

3.16.0

processId

processId: null | number

The process Id of the parent process that started the server.

Is null if the process has not been started by another process. If the parent process is not alive then the server should exit.

OptionalrootPath

rootPath?: null | string

The rootPath of the workspace. Is null if no folder is open.

Deprecated

in favour of rootUri.

rootUri

rootUri: null | string

The rootUri of the workspace. Is null if no folder is open. If both rootPath and rootUri are set rootUri wins.

Deprecated

in favour of workspaceFolders.

Optionaltrace

trace?: TraceValue

The initial trace setting. If omitted trace is disabled ('off').

OptionalworkDoneToken

workDoneToken?: ProgressToken

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

Settings

Member Visibility

On This Page

Properties