Class CodecError

constructor

• new CodecError(source, message?, options?): CodecError

• Parameters

  • source: CodecErrorSource

  • Optional message: string

  • Optional options: ErrorOptions

  Returns CodecError

Readonly issue

Readonly source

addChild

• addChild(key, issue): CodecError

• Parameters

  • key: string | number

  • issue: CodecIssue

  Returns CodecError

addChildren

• addChildren(children): CodecError

• Parameters

  • children: Iterable<[string | number, CodecIssue]>

  Returns CodecError

collectMessages

• collectMessages(formatter?): string[]

• Parameters

  • Optional formatter: ((path, message) => string)

    • • (path, message): string

      • Parameters

        • path: (string | number)[]

        • message: string

        Returns string

  Returns string[]

Static create

• create(source, message?, options?): CodecError

• Parameters

  • source: CodecErrorSource

  • Optional message: string

  • Optional options: ErrorOptions

  Returns CodecError

Static expectByteLength

• expectByteLength(expectedLength, actualLength, options?): CodecError

• Parameters

  • expectedLength: number

  • actualLength: number

  • Optional options: ErrorOptions

  Returns CodecError

Static expectMinimalByteLength

• expectMinimalByteLength(expectedMinimalLength, actualLength, options?): CodecError

• Parameters

  • expectedMinimalLength: number

  • actualLength: number

  • Optional options: ErrorOptions

  Returns CodecError