Class RequestError

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 authRequired toResult

Constructors

constructor

new RequestError(code: number, message: string, details?: string): RequestError
Parameters
- code: number
- message: string
- Optionaldetails: string
Returns RequestError
Overrides Error.constructor
- Defined in typescript/acp.ts:546

Properties

`Optional`data

data?: { details?: string }

code

code: number

Methods

`Static`parseError

parseError(details?: string): RequestError
Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.
Parameters
- Optionaldetails: string
Returns RequestError
- Defined in typescript/acp.ts:561

`Static`invalidRequest

invalidRequest(details?: string): RequestError
The JSON sent is not a valid Request object.
Parameters
- Optionaldetails: string
Returns RequestError
- Defined in typescript/acp.ts:568

`Static`methodNotFound

methodNotFound(details?: string): RequestError
The method does not exist / is not available.
Parameters
- Optionaldetails: string
Returns RequestError
- Defined in typescript/acp.ts:575

`Static`invalidParams

invalidParams(details?: string): RequestError
Invalid method parameter(s).
Parameters
- Optionaldetails: string
Returns RequestError
- Defined in typescript/acp.ts:582

`Static`internalError

internalError(details?: string): RequestError
Internal JSON-RPC error.
Parameters
- Optionaldetails: string
Returns RequestError
- Defined in typescript/acp.ts:589

`Static`authRequired

authRequired(details?: string): RequestError
Authentication required.
Parameters
- Optionaldetails: string
Returns RequestError
- Defined in typescript/acp.ts:596

toResult

toResult<T>(): Result<T>
Type Parameters
- T
Returns Result<T>
- Defined in typescript/acp.ts:600