Class RequestError`Experimental`

JSON-RPC error object.

Represents an error that occurred during method execution, following the JSON-RPC 2.0 error object specification with optional additional data.

See protocol docs: JSON-RPC Error Object

Hierarchy

Error
- RequestError

Index

Constructors

Properties

Methods

parseError invalidRequest methodNotFound invalidParams internalError requestCancelled authRequired resourceNotFound toResult toErrorResponse

Constructors

constructor

new RequestError(code: number, message: string, data?: unknown): RequestError
Experimental
Parameters
- code: number
  JSON-RPC error code.
- message: string
- Optionaldata: unknown
Returns RequestError
Overrides Error.constructor
- Defined in jsonrpc.ts:1665

Properties

`Optional` `Experimental`data

data?: unknown

Additional JSON-RPC error data.

`Experimental`code

code: number

JSON-RPC error code.

Methods

`Static`parseError

parseError(data?: unknown, additionalMessage?: string): RequestError
Experimental
Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.
Parameters
- Optionaldata: unknown
- OptionaladditionalMessage: string
Returns RequestError
- Defined in jsonrpc.ts:1681

`Static`invalidRequest

invalidRequest(data?: unknown, additionalMessage?: string): RequestError
Experimental
The JSON sent is not a valid Request object.
Parameters
- Optionaldata: unknown
- OptionaladditionalMessage: string
Returns RequestError
- Defined in jsonrpc.ts:1692

`Static`methodNotFound

methodNotFound(method: string): RequestError
Experimental
The method does not exist / is not available.
Parameters
- method: string
Returns RequestError
- Defined in jsonrpc.ts:1706

`Static`invalidParams

invalidParams(data?: unknown, additionalMessage?: string): RequestError
Experimental
Invalid method parameter(s).
Parameters
- Optionaldata: unknown
- OptionaladditionalMessage: string
Returns RequestError
- Defined in jsonrpc.ts:1715

`Static`internalError

internalError(data?: unknown, additionalMessage?: string): RequestError
Experimental
Internal JSON-RPC error.
Parameters
- Optionaldata: unknown
- OptionaladditionalMessage: string
Returns RequestError
- Defined in jsonrpc.ts:1729

`Static`requestCancelled

requestCancelled(data?: unknown, additionalMessage?: string): RequestError
Experimental
Execution of the request was aborted.
Parameters
- Optionaldata: unknown
- OptionaladditionalMessage: string
Returns RequestError
- Defined in jsonrpc.ts:1743

`Static`authRequired

authRequired(data?: unknown, additionalMessage?: string): RequestError
Experimental
Authentication required.
Parameters
- Optionaldata: unknown
- OptionaladditionalMessage: string
Returns RequestError
- Defined in jsonrpc.ts:1757

`Static`resourceNotFound

resourceNotFound(uri?: string): RequestError
Experimental
Resource, such as a file, was not found
Parameters
- Optionaluri: string
Returns RequestError
- Defined in jsonrpc.ts:1771

toResult

toResult<T>(): Result<T>
Experimental
Converts this error to a JSON-RPC result object.
Type Parameters
- T
Returns Result<T>
- Defined in jsonrpc.ts:1782

toErrorResponse

toErrorResponse(): ErrorResponse
Experimental
Converts this error to a JSON-RPC error response payload.

Returns ErrorResponse
- Defined in jsonrpc.ts:1795