jsonRpc

Index

Functions

• isBatchRequest
• isBatchResponse
• isResponseRpcError
• isResponseWithError
• isResponseWithNotification
• isResponseWithResult
• isSubscriptionResult
• isValidResponse
• setRequestIdStart
• toBatchPayload
• toPayload
• validateResponse

Functions

isBatchRequest

• isBatchRequest(request: JsonRpcBatchRequest | JsonRpcOptionalRequest<unknown> | JsonRpcRequest<unknown>): request is JsonRpcBatchRequest

• Parameters

  • request: JsonRpcBatchRequest | JsonRpcOptionalRequest<unknown> | JsonRpcRequest<unknown>

  Returns request is JsonRpcBatchRequest

isBatchResponse

• isBatchResponse<Result, Error>(response: JsonRpcResponse<Result, Error>): response is JsonRpcBatchResponse<Result, Error>

• Type parameters

  • Result = unknown
  • Error = unknown

  Parameters

  • response: JsonRpcResponse<Result, Error>

  Returns response is JsonRpcBatchResponse<Result, Error>

isResponseRpcError

• isResponseRpcError(rpcError: JsonRpcResponseWithError<JsonRpcResult>): boolean

• Parameters

  • rpcError: JsonRpcResponseWithError<JsonRpcResult>

  Returns boolean

isResponseWithError

• isResponseWithError<Error, Result>(response: JsonRpcResponse<Result, Error>): response is JsonRpcResponseWithError<Error>

• Type parameters

  • Error = unknown
  • Result = unknown

  Parameters

  • response: JsonRpcResponse<Result, Error>

  Returns response is JsonRpcResponseWithError<Error>

isResponseWithNotification

• isResponseWithNotification<Result>(response: JsonRpcSubscriptionResult | JsonRpcNotification<Result>): response is JsonRpcNotification<Result>

• Type parameters

  • Result

  Parameters

  • response: JsonRpcSubscriptionResult | JsonRpcNotification<Result>

  Returns response is JsonRpcNotification<Result>

isResponseWithResult

• isResponseWithResult<Result, Error>(response: JsonRpcResponse<Result, Error>): response is JsonRpcResponseWithResult<Result>

• Type parameters

  • Result = unknown
  • Error = unknown

  Parameters

  • response: JsonRpcResponse<Result, Error>

  Returns response is JsonRpcResponseWithResult<Result>

isSubscriptionResult

• isSubscriptionResult<Result>(response: JsonRpcSubscriptionResult | JsonRpcNotification<Result>): response is JsonRpcSubscriptionResult

• Type parameters

  • Result

  Parameters

  • response: JsonRpcSubscriptionResult | JsonRpcNotification<Result>

  Returns response is JsonRpcSubscriptionResult

isValidResponse

• isValidResponse<Result, Error>(response: JsonRpcResponse<Result, Error>): boolean

• Type parameters

  • Result = unknown
  • Error = unknown

  Parameters

  • response: JsonRpcResponse<Result, Error>

  Returns boolean

setRequestIdStart

• setRequestIdStart(start: undefined | number): void

• Optionally use to make the jsonrpc id start from a specific number. Without calling this function, the id will be filled with a Uuid. But after this being called with a number, the id will be a number starting from the provided start variable. However, if undefined was passed to this function, the id will be a Uuid again.

  ---

  Parameters

  • start: undefined | number

    a number to start incrementing from. Or undefined to use a new Uuid (this is the default behavior)

  Returns void

toBatchPayload

• toBatchPayload(requests: JsonRpcOptionalRequest<unknown>[]): JsonRpcBatchRequest

• Parameters

  • requests: JsonRpcOptionalRequest<unknown>[]

  Returns JsonRpcBatchRequest

toPayload

• toPayload<ParamType>(request: JsonRpcOptionalRequest<ParamType>): JsonRpcPayload<ParamType>

• Type parameters

  • ParamType = unknown[]

  Parameters

  • request: JsonRpcOptionalRequest<ParamType>

  Returns JsonRpcPayload<ParamType>

validateResponse

• validateResponse<Result, Error>(response: JsonRpcResponse<Result, Error>): boolean

• Type parameters

  • Result = unknown
  • Error = unknown

  Parameters

  • response: JsonRpcResponse<Result, Error>

  Returns boolean