lspeasy / client/src / ClientOptions
Interface: ClientOptions<ClientCaps>
Defined in: packages/client/src/types.ts:38
Configuration for an LSPClient instance.
Remarks
Passed to the LSPClient constructor. All fields are optional; the client works with zero configuration.
Config
Type Parameters
| Type Parameter | Default type |
|---|---|
ClientCaps extends Partial<Transport> | Transport |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
capabilities? | ClientCaps | Client capabilities to advertise | packages/client/src/types.ts:54 |
dynamicRegistration? | any | Behavior controls for server-driven dynamic registration. | packages/client/src/types.ts:91 |
heartbeat? | HeartbeatConfig | Optional heartbeat configuration (disabled by default). | packages/client/src/types.ts:86 |
logger? | any | Logger instance for client logging | packages/client/src/types.ts:59 |
logLevel? | any | Log level for built-in console logger | packages/client/src/types.ts:64 |
middleware? | any[] | Optional middleware chain for clientToServer/serverToClient messages. | packages/client/src/types.ts:81 |
name? | string | Client identification (sent in initialize request) | packages/client/src/types.ts:44 |
onValidationError? | (error, response) => void | Callback for response validation errors | packages/client/src/types.ts:96 |
requestTimeout? | number | Default request timeout in milliseconds for outgoing requests | packages/client/src/types.ts:69 |
strictCapabilities? | boolean | Strict capability checking mode When true, throws error if handler registered or request sent for unsupported capability When false, logs warning and allows registration/sending (default: false) | packages/client/src/types.ts:76 |
version? | string | Client version | packages/client/src/types.ts:49 |