Skip to content
Singapore

TypeScriptLspPluginOptions

TypeScriptLspPluginOptions = object

Properties

Section titled “Properties”

canonicalPaths?

Section titled “canonicalPaths?”

readonly optional canonicalPaths?: Readonly<Record<string, string>>

Logical filesystem names mapped to their canonical source identity.

capabilities?

Section titled “capabilities?”

readonly optional capabilities?: lsp.ClientCapabilities

Merged over defaultClientCapabilities(). Build a semantic-tokens block with semanticTokensClientCapability() from @singapore-editor/lsp rather than by hand — the worker advertises semanticTokensProvider, but a server only answers a client that asked.

clientInfo?

Section titled “clientInfo?”

readonly optional clientInfo?: lsp.InitializeParams["clientInfo"]

compilerOptions?

Section titled “compilerOptions?”

readonly optional compilerOptions?: ts.CompilerOptions

connectionProvider?

Section titled “connectionProvider?”

readonly optional connectionProvider?: LspConnectionProvider

diagnosticDelayMs?

Section titled “diagnosticDelayMs?”

readonly optional diagnosticDelayMs?: number

documentSync?

Section titled “documentSync?”

readonly optional documentSync?: LanguageServerDocumentSyncOptions

getDiagnosticActions?

Section titled “getDiagnosticActions?”

readonly optional getDiagnosticActions?: LanguageServerDiagnosticActions

libraryFiles?

Section titled “libraryFiles?”

readonly optional libraryFiles?: "bundled" | "cdn" | TypeScriptLspLibraryLoader

The standard library: bundled with this package unless the host opts into the CDN or its own.

onApplyWorkspaceEdit?

Section titled “onApplyWorkspaceEdit?”

readonly optional onApplyWorkspaceEdit?: OnApplyWorkspaceEdit

Applies rename and code-action edits. Without it, an edit that spans files cannot land and reports that instead.

onDiagnostics?

Section titled “onDiagnostics?”

readonly optional onDiagnostics?: (summary) => void

Parameters

Section titled “Parameters”
summary
Section titled “summary”

TypeScriptLspDiagnosticSummary

Returns

Section titled “Returns”

void

onError?

Section titled “onError?”

readonly optional onError?: (error) => void

Parameters

Section titled “Parameters”
error
Section titled “error”

unknown

Returns

Section titled “Returns”

void

onOpenDefinition?

Section titled “onOpenDefinition?”

readonly optional onOpenDefinition?: (target, options?) => void | boolean

Parameters

Section titled “Parameters”
target
Section titled “target”

TypeScriptLspDefinitionTarget

options?
Section titled “options?”

TypeScriptLspNavigationOptions

Returns

Section titled “Returns”

void | boolean

onOpenReferences?

Section titled “onOpenReferences?”

readonly optional onOpenReferences?: (result) => void | boolean

Parameters

Section titled “Parameters”
result
Section titled “result”

TypeScriptLspReferencesResult

Returns

Section titled “Returns”

void | boolean

onRequestError?

Section titled “onRequestError?”

readonly optional onRequestError?: (method, error) => void

Parameters

Section titled “Parameters”
method
Section titled “method”

string

error
Section titled “error”

unknown

Returns

Section titled “Returns”

void

onStatusChange?

Section titled “onStatusChange?”

readonly optional onStatusChange?: (status) => void

Parameters

Section titled “Parameters”
status
Section titled “status”

TypeScriptLspStatus

Returns

Section titled “Returns”

void

rootUri?

Section titled “rootUri?”

readonly optional rootUri?: lsp.DocumentUri | null

semanticTokens?

Section titled “semanticTokens?”

readonly optional semanticTokens?: LanguageServerSemanticTokensOptions

Turns on the semantic token layer and is how a host gets hold of one. Supplying nothing creates no layer and fires no demand signal, so an app that paints no semantic colour pays nothing.

timeoutMs?

Section titled “timeoutMs?”

readonly optional timeoutMs?: number

webSocketRoute?

Section titled “webSocketRoute?”

readonly optional webSocketRoute?: string | URL

webSocketTransportOptions?

Section titled “webSocketTransportOptions?”

readonly optional webSocketTransportOptions?: LspWebSocketTransportOptions

workerFactory?

Section titled “workerFactory?”

readonly optional workerFactory?: () => LspWorkerLike

Returns

Section titled “Returns”

LspWorkerLike

workspace?

Section titled “workspace?”

readonly optional workspace?: TypeScriptLspWorkspace

Methods

Section titled “Methods”

onConnectionCreated()?

Section titled “onConnectionCreated()?”

optional onConnectionCreated(context): void | EditorDisposable

Hands the host the connection the moment it exists, which is the only way to reach the LspClient — and therefore to issue a token request, cancel one, or override its timeout. Runs alongside this plugin’s own registration rather than replacing it.

Parameters

Section titled “Parameters”
context
Section titled “context”

LanguageServerConnectionContext

Returns

Section titled “Returns”

void | EditorDisposable