@blockchaincommons/dcbor - v1.0.0-beta.1
    Preparing search index...

    Interface CborErrorDetails

    Optional structured data attached to a CborError, keyed by the codes that carry it. Everything is optional so callers can narrow on code and read only the fields relevant to that code.

    Use CborErrorDetailsByCode (per-code payloads) with CborErrorTyped - narrowing on error.code then makes the matching detail fields non-optional. This undiscriminated bag remains for compatibility and is removed at 2.0.

    interface CborErrorDetails {
        headerValue?: number;
        count?: number;
        expectedTag?: Tag;
        actualTag?: Tag;
        cause?: string;
    }
    Index
    headerValue? count? expectedTag? actualTag? cause?
    headerValue?: number

    UnsupportedHeaderValue: the offending CBOR header byte.

    count?: number

    UnusedData: number of trailing bytes left unconsumed.

    expectedTag?: Tag

    WrongTag: the tag that was expected.

    actualTag?: Tag

    WrongTag: the tag actually found.

    cause?: string

    InvalidString/InvalidUtf8/InvalidDate: the underlying reason.

    Settings
    Member Visibility

    On This Page
    Properties