Skip to main content
Version: Next

Class: RpcError<BaseErrorT>

Defined in: src/utils/errors/index.ts:44

Extends​

Type Parameters​

BaseErrorT​

BaseErrorT extends RPC_ERROR = RPC_ERROR

Constructors​

Constructor​

new RpcError<BaseErrorT>(baseError, method, params): RpcError<BaseErrorT>

Defined in: src/utils/errors/index.ts:50

Parameters​

baseError​

BaseErrorT

method​

string

params​

any

Returns​

RpcError<BaseErrorT>

Overrides​

LibraryError.constructor

Properties​

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

LibraryError.stackTraceLimit

request​

readonly request: object

Defined in: src/utils/errors/index.ts:45

method​

method: string

params​

params: any

baseError​

readonly baseError: BaseErrorT

Defined in: src/utils/errors/index.ts:51

name​

name: string

Defined in: src/utils/errors/index.ts:21

Inherited from​

LibraryError.name

message​

message: string

Defined in: www/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

LibraryError.message

stack?​

optional stack?: string

Defined in: www/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

LibraryError.stack

cause?​

optional cause?: unknown

Defined in: www/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

LibraryError.cause

Accessors​

code​

Get Signature​

get code(): 1 | 10 | 20 | 21 | 24 | 27 | 28 | 29 | 31 | 32 | 33 | 34 | 40 | 41 | 42 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 100 | 150 | 151 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 163

Defined in: src/utils/errors/index.ts:62

Returns​

1 | 10 | 20 | 21 | 24 | 27 | 28 | 29 | 31 | 32 | 33 | 34 | 40 | 41 | 42 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 100 | 150 | 151 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 163

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

LibraryError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

LibraryError.prepareStackTrace

isType()​

isType<N, C>(typeName): this is RpcError<RPC_ERROR_SET[N] & { code: C }>

Defined in: src/utils/errors/index.ts:73

Verifies the underlying RPC error, also serves as a type guard for the baseError property

Type Parameters​

N​

N extends keyof RPC_ERROR_SET

C​

C extends 1 | 10 | 20 | 21 | 24 | 27 | 28 | 29 | 31 | 32 | 33 | 34 | 40 | 41 | 42 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 100 | 150 | 151 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 163

Parameters​

typeName​

N

Returns​

this is RpcError<RPC_ERROR_SET[N] & { code: C }>

Example​

SomeError.isType('UNEXPECTED_ERROR');