Class: RpcError<BaseErrorT>

Type parameters

Name	Type
BaseErrorT	extends RPC_ERROR = RPC_ERROR

Hierarchy

• LibraryError

  ↳ RpcError

Constructors

constructor

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

Type parameters

Name	Type
BaseErrorT	extends RPC_ERROR = RPC_ERROR

Parameters

Name	Type
baseError	BaseErrorT
method	string
params	any

Returns

RpcError<BaseErrorT>

Overrides

LibraryError.constructor

Defined in

src/utils/errors/index.ts:50

Properties

stackTraceLimit

▪ Static stackTraceLimit: number

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

Defined in

node_modules/@types/node/globals.d.ts:162

---

request

• Readonly request: Object

Type declaration

Name	Type
method	string
params	any

Defined in

src/utils/errors/index.ts:45

---

baseError

• Readonly baseError: BaseErrorT

Defined in

src/utils/errors/index.ts:51

---

name

• name: string

Inherited from

LibraryError.name

Defined in

src/utils/errors/index.ts:21

---

message

• message: string

Inherited from

LibraryError.message

Defined in

www/node_modules/typescript/lib/lib.es5.d.ts:1055

---

stack

• Optional stack: string

Inherited from

LibraryError.stack

Defined in

www/node_modules/typescript/lib/lib.es5.d.ts:1056

---

cause

• Optional cause: unknown

Inherited from

LibraryError.cause

Defined in

www/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Accessors

code

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

Returns

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

Defined in

src/utils/errors/index.ts:62

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

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

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

LibraryError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:146

---

prepareStackTrace

▸ prepareStackTrace(err, stackTraces): any

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

LibraryError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:150

---

isType

▸ isType<N, C>(typeName): this is RpcError<RPC_ERROR_SET[N] & Object>

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

Type parameters

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

Parameters

Name	Type
typeName	N

Returns

this is RpcError<RPC_ERROR_SET[N] & Object>

Example

SomeError.isType('UNEXPECTED_ERROR');

Defined in

src/utils/errors/index.ts:73