Skip to content

Type Alias: JSONRPCRequest ​

JSONRPCRequest = object

A JSON-RPC 2.0 request, as a client sends it. Without an id, it is a notification: the action runs but no response is sent.

Properties ​

id? ​

optional id?: string | number | null

The request id, echoed in its response; omitted for a notification.


jsonrpc ​

jsonrpc: "2.0"

The protocol version, always '2.0'.


method ​

method: string

The method, mapped to the service action's pattern (see JSONRPCMappingOptions).


params? ​

optional params?: Record<string, unknown> | unknown[]

The params: by name (an object, merged into the action's input), or by position (an array, accepted only with the positionalParams option).

Released under the MIT License.