Skip to content

lspeasy / core/src / RequestMessage

Interface: RequestMessage

Defined in: packages/core/src/jsonrpc/messages.ts:35

JSON-RPC 2.0 Request message — expects a response from the peer.

Remarks

The id field uniquely identifies the request within a connection session. Per the JSON-RPC 2.0 spec, id may be a string or number — never assume integers only.

Never

NEVER assume JSON-RPC IDs are integers. The spec permits strings, and some LSP clients (e.g. VS Code extensions) use string IDs. Always use String(id) when keying pending-request maps.

Extends

Properties

PropertyTypeDescriptionOverridesDefined in
idstring | numberUnique identifier correlating this request to its eventual response.-packages/core/src/jsonrpc/messages.ts:37
jsonrpc"2.0"JSON-RPC protocol version — always "2.0" (inherited).BaseMessage.jsonrpcpackages/core/src/jsonrpc/messages.ts:41
methodstringLSP method string, e.g. 'textDocument/hover'.-packages/core/src/jsonrpc/messages.ts:39
params?unknownOptional request parameters (method-specific shape).-packages/core/src/jsonrpc/messages.ts:43

Released under the MIT License.