Class ErrorPolykeyCLIRecoveryCodeFileRead<T>

Root error for Polykey CLI. Application errors may need to be serialised over program boundaries. For example presenting errors on the terminal, or sending errors over the network.

Type Parameters

Hierarchy

ErrorPolykeyCLI<T>
- ErrorPolykeyCLIRecoveryCodeFileRead

Index

Constructors

constructor

new ErrorPolykeyCLIRecoveryCodeFileRead<T>(message?, options?): ErrorPolykeyCLIRecoveryCodeFileRead<T>
Type Parameters
- T
Parameters
- Optional message: string
- Optional options: {
      cause?: T;
      data?: POJO;
      timestamp?: Date;
  }
  - Optional cause?: T
  - Optional data?: POJO
  - Optional timestamp?: Date
Returns ErrorPolykeyCLIRecoveryCodeFileRead<T>
Inherited from ErrorPolykeyCLI.constructor
- Defined in node_modules/@matrixai/errors/dist/AbstractError.d.ts:34

Properties

cause

cause: T

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

data

data: POJO

Arbitrary data

exitCode

exitCode: 66 = sysexits.NOINPUT

message

message: string

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 = 'Failed to read recovery code file'

`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 ErrorPolykeyCLI.description
- Defined in node_modules/@matrixai/errors/dist/AbstractError.d.ts:39

Methods

toJSON

toJSON(): any
Returns any
Inherited from ErrorPolykeyCLI.toJSON
- Defined in src/errors.ts:42

`Static` captureStackTrace

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

`Static` fromJSON

fromJSON<T>(this, json): InstanceType<T>
Type Parameters
- T extends Class<any>
Parameters
- this: T
- json: any
Returns InstanceType<T>
Inherited from ErrorPolykeyCLI.fromJSON
- Defined in src/errors.ts:15

Class ErrorPolykeyCLIRecoveryCodeFileRead<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

Optional message: string

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

Optional cause?: T

Optional data?: POJO

Optional timestamp?: Date

Returns ErrorPolykeyCLIRecoveryCodeFileRead<T>

Properties

cause

data

exitCode

message

name

Optional stack

timestamp

Static description

Static Optional prepareStackTrace

Type declaration

Parameters

err: Error

stackTraces: CallSite[]

Returns any

See

Static stackTraceLimit

Accessors

description

Returns string

Methods

toJSON

Returns any

Static captureStackTrace

Parameters

targetObject: object

Optional constructorOpt: Function

Returns void

Static fromJSON

Type Parameters

T extends Class<any>

Parameters

this: T

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` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Static` captureStackTrace

`Optional` constructorOpt: Function

`Static` fromJSON