Class ErrorParse

Exception to be thrown during parsing failure This is not part of the Polykey exception hierarchy This is because it plain exception wrapper parsing error data While JS allows us to throw POJOs directly, having a nominal type is easier to check against

Hierarchy

  • AbstractError<void>
    • ErrorParse

Constructors

constructor

Properties

cause context data exitCode keyPath message name stack? timestamp value description prepareStackTrace? stackTraceLimit

Accessors

description

Methods

toJSON captureStackTrace fromJSON

Constructors

constructor

  • Parameters

    • Optional message: string
    • Optional options: {
          cause?: void;
          data?: POJO;
          timestamp?: Date;
      }
      • Optional cause?: void
      • Optional data?: POJO
      • Optional timestamp?: Date

    Returns ErrorParse

Properties

cause

cause: void

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

context

context: object

data

data: POJO

Arbitrary data

exitCode

exitCode: 65 = sysexits.DATAERR

keyPath

keyPath: string[]

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

value

value: any

Static description

description: string = 'Failed to parse data into valid format'

Static Optional prepareStackTrace

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

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • Encoding to JSON pojo When overriding this, you can use super.toJSON The replacer will:

    • delete undefined values in objects
    • replace undefined values for null in arrays

    Returns any

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • 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

    • this: T
    • json: any

    Returns InstanceType<T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc