Class ErrorRPCRemote<T>

Type Parameters

Hierarchy

ErrorRPCProtocol<T>
- ErrorRPCRemote

Index

Constructors

constructor

new ErrorRPCRemote<T>(metadata, message?, options?): ErrorRPCRemote<T>
Type Parameters
- T
Parameters
- metadata: JSONValue
- Optional message: string
- Optional options: {
      cause?: T;
      data?: POJO;
      timestamp?: Date;
  }
  - Optional cause?: T
  - Optional data?: POJO
  - Optional timestamp?: Date
Returns ErrorRPCRemote<T>
Overrides ErrorRPCProtocol.constructor
- Defined in src/errors.ts:137

Properties

cause

cause: T

Causation of the exception Can be used to know what caused this exception

code

code: JSONRPCResponseErrorCode = JSONRPCResponseErrorCode.RPCRemote

data

data: POJO

Arbitrary data

message

message: string

metadata

metadata: JSONValue

name

name: string

`Optional` stack

stack?: string

timestamp

timestamp: Date

Timestamp when exception was constructed in milliseconds Guaranteed to be weakly monotonic

`Static` description

description: string = 'Remote error from RPC call'

`Static` error

error: string = 'RPC Protocol Error'

`Static` message

message: string = 'The server responded with an error'

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

description

get description(): string
Returns string
Inherited from ErrorRPCProtocol.description
- Defined in node_modules/@matrixai/errors/dist/AbstractError.d.ts:39

Methods

toJSON

toJSON(): JSONRPCResponseError
The return type WILL NOT include cause, this will be handled by fromError

Returns JSONRPCResponseError
Inherited from ErrorRPCProtocol.toJSON
- Defined in src/errors.ts:74

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from ErrorRPCProtocol.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

`Static` fromJSON

fromJSON<T>(json): InstanceType<T>
Runtime decoding of JSON POJO to exception instance When overriding this, you cannot use super.fromJSON You must write it fully, and use the same type-hacks to support polymorphic this in static methods https://github.com/microsoft/TypeScript/issues/5863
Type Parameters
- T extends Class<any>
Parameters
- json: any
Returns InstanceType<T>
Inherited from ErrorRPCProtocol.fromJSON
- Defined in src/errors.ts:42

Class ErrorRPCRemote<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

metadata: JSONValue

Optional message: string

Optional options: { cause?: T; data?: POJO; timestamp?: Date; }

Optional cause?: T

Optional data?: POJO

Optional timestamp?: Date

Returns ErrorRPCRemote<T>

Properties

cause

code

data

message

metadata

name

Optional stack

timestamp

Static description

Static error

Static message

Static Optional prepareStackTrace

Type declaration

Parameters

err: Error

stackTraces: CallSite[]

Returns any

See

Static stackTraceLimit

Accessors

description

Returns string

Methods

toJSON

Returns JSONRPCResponseError

Static captureStackTrace

Parameters

targetObject: object

Optional constructorOpt: Function

Returns void

Static fromJSON

Type Parameters

T extends Class<any>

Parameters

json: any

Returns InstanceType<T>

Settings

Member Visibility

Theme

On This Page

`Optional` message: string

`Optional` options: {
cause?: T;
data?: POJO;
timestamp?: Date;
}

`Optional` cause?: T

`Optional` data?: POJO

`Optional` timestamp?: Date

`Optional` stack

`Static` description

`Static` error

`Static` message

`Static` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Static` captureStackTrace

`Optional` constructorOpt: Function

`Static` fromJSON