Class CborError

The single error type thrown by dCBOR encoding, decoding, and extraction.

Example

try {
  decodeCbor(bytes);
} catch (e) {
  if (CborError.isCborError(e) && e.code === "WrongTag") {
    console.log(e.details.expectedTag, e.details.actualTag);
  }
}

Hierarchy

Error
- CborError

Index

Constructors

constructor

new CborError(
    code: CborErrorCode,
    message: string,
    details?: CborErrorDetails,
): CborError
Parameters
- code: CborErrorCode
- message: string
- details: CborErrorDetails = {}
Returns CborError
Overrides Error.constructor
- Defined in error.ts:142

Properties

`Readonly`code

code: CborErrorCode

Machine-readable discriminant; switch on this to handle errors.

`Readonly`details

details: CborErrorDetails

Structured, code-specific data (see CborErrorDetails).

Methods

`Static`isCborError

isCborError(
    value: unknown,
): value is
    | CborError & {
        code: "OutOfRange";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "Custom";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "WrongType";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "UnusedData";
        details: Readonly<{ count: number }> & CborErrorDetails;
    }
    | CborError & {
        code: "Underrun";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "UnsupportedHeaderValue";
        details: Readonly<{ headerValue: number }> & CborErrorDetails;
    }
    | CborError & {
        code: "NonCanonicalNumeric";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidSimpleValue";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidString";
        details: Readonly<{ cause: string }> & CborErrorDetails;
    }
    | CborError & {
        code: "NonCanonicalString";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "MisorderedMapKey";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "DuplicateMapKey";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "MissingMapKey";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "WrongTag";
        details: Readonly<{ expectedTag: Tag; actualTag: Tag }> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidUtf8";
        details: Readonly<{ cause: string }> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidDate";
        details: Readonly<{ cause: string }> & CborErrorDetails;
    }
Type guard: is value a CborError? Narrows to the code-discriminated CborErrorTyped union.
Parameters
- value: unknown
Returns value is
    | CborError & {
        code: "OutOfRange";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "Custom";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "WrongType";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "UnusedData";
        details: Readonly<{ count: number }> & CborErrorDetails;
    }
    | CborError & {
        code: "Underrun";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "UnsupportedHeaderValue";
        details: Readonly<{ headerValue: number }> & CborErrorDetails;
    }
    | CborError & {
        code: "NonCanonicalNumeric";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidSimpleValue";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidString";
        details: Readonly<{ cause: string }> & CborErrorDetails;
    }
    | CborError & {
        code: "NonCanonicalString";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "MisorderedMapKey";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "DuplicateMapKey";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "MissingMapKey";
        details: Readonly<unknown> & CborErrorDetails;
    }
    | CborError & {
        code: "WrongTag";
        details: Readonly<{ expectedTag: Tag; actualTag: Tag }> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidUtf8";
        details: Readonly<{ cause: string }> & CborErrorDetails;
    }
    | CborError & {
        code: "InvalidDate";
        details: Readonly<{ cause: string }> & CborErrorDetails;
    }
- Defined in error.ts:156

`Static`underrun

underrun(): CborError & {
code: "Underrun";
details: Readonly<unknown> & CborErrorDetails;
}
The CBOR data ended before a complete item could be decoded.

Returns CborError & { code: "Underrun"; details: Readonly<unknown> & CborErrorDetails }
- Defined in error.ts:161

`Static`unsupportedHeaderValue

unsupportedHeaderValue(
    headerValue: number,
): CborError & {
    code: "UnsupportedHeaderValue";
    details: Readonly<{ headerValue: number }> & CborErrorDetails;
}
An unsupported/invalid value was found in a CBOR header byte.
Parameters
- headerValue: number
Returns CborError & {
code: "UnsupportedHeaderValue";
details: Readonly<{ headerValue: number }> & CborErrorDetails;
}
- Defined in error.ts:166

`Static`nonCanonicalNumeric

nonCanonicalNumeric(): CborError & {
code: "NonCanonicalNumeric";
details: Readonly<unknown> & CborErrorDetails;
}
A numeric value was not in its shortest/canonical dCBOR form.

Returns CborError & {
code: "NonCanonicalNumeric";
details: Readonly<unknown> & CborErrorDetails;
}
- Defined in error.ts:173

`Static`invalidSimpleValue

invalidSimpleValue(): CborError & {
code: "InvalidSimpleValue";
details: Readonly<unknown> & CborErrorDetails;
}
A major-type-7 simple value other than false/true/null/float.

Returns CborError & {
code: "InvalidSimpleValue";
details: Readonly<unknown> & CborErrorDetails;
}
- Defined in error.ts:181

`Static`invalidString

invalidString(
    cause: string,
): CborError & {
    code: "InvalidString";
    details: Readonly<{ cause: string }> & CborErrorDetails;
}
A text string was not valid UTF-8 (with the underlying reason).
Parameters
- cause: string
Returns CborError & {
code: "InvalidString";
details: Readonly<{ cause: string }> & CborErrorDetails;
}
- Defined in error.ts:189

`Static`nonCanonicalString

nonCanonicalString(): CborError & {
code: "NonCanonicalString";
details: Readonly<unknown> & CborErrorDetails;
}
A text string was not in Unicode NFC.

Returns CborError & {
code: "NonCanonicalString";
details: Readonly<unknown> & CborErrorDetails;
}
- Defined in error.ts:198

`Static`unusedData

unusedData(
    count: number,
): CborError & {
    code: "UnusedData";
    details: Readonly<{ count: number }> & CborErrorDetails;
}
The decoded item left count trailing bytes unconsumed.
Parameters
- count: number
Returns CborError & {
code: "UnusedData";
details: Readonly<{ count: number }> & CborErrorDetails;
}
- Defined in error.ts:206

`Static`misorderedMapKey

misorderedMapKey(): CborError & {
code: "MisorderedMapKey";
details: Readonly<unknown> & CborErrorDetails;
}
Map keys were not in canonical ascending byte order.

Returns CborError & {
code: "MisorderedMapKey";
details: Readonly<unknown> & CborErrorDetails;
}
- Defined in error.ts:213

`Static`duplicateMapKey

duplicateMapKey(): CborError & {
code: "DuplicateMapKey";
details: Readonly<unknown> & CborErrorDetails;
}
A map contained a duplicate key.

Returns CborError & {
code: "DuplicateMapKey";
details: Readonly<unknown> & CborErrorDetails;
}
- Defined in error.ts:221

`Static`missingMapKey

missingMapKey(): CborError & {
code: "MissingMapKey";
details: Readonly<unknown> & CborErrorDetails;
}
A requested map key was not present.

Returns CborError & {
code: "MissingMapKey";
details: Readonly<unknown> & CborErrorDetails;
}
- Defined in error.ts:229

`Static`outOfRange

outOfRange(): CborError & {
code: "OutOfRange";
details: Readonly<unknown> & CborErrorDetails;
}
A numeric value could not be represented in the target type.

Returns CborError & {
code: "OutOfRange";
details: Readonly<unknown> & CborErrorDetails;
}
- Defined in error.ts:237

`Static`wrongType

wrongType(): CborError & {
code: "WrongType";
details: Readonly<unknown> & CborErrorDetails;
}
The CBOR value was not the type expected by a conversion.

Returns CborError & { code: "WrongType"; details: Readonly<unknown> & CborErrorDetails }
- Defined in error.ts:245

`Static`wrongTag

wrongTag(
    expected: Tag,
    actual: Tag,
): CborError & {
    code: "WrongTag";
    details: Readonly<{ expectedTag: Tag; actualTag: Tag }> & CborErrorDetails;
}
A tagged value had a tag other than the one expected.
Parameters
- expected: Tag
- actual: Tag
Returns CborError & {
code: "WrongTag";
details: Readonly<{ expectedTag: Tag; actualTag: Tag }> & CborErrorDetails;
}
- Defined in error.ts:253

`Static`invalidUtf8

invalidUtf8(
    cause: string,
): CborError & {
    code: "InvalidUtf8";
    details: Readonly<{ cause: string }> & CborErrorDetails;
}
Invalid UTF-8 in a text string (with the underlying reason).
Parameters
- cause: string
Returns CborError & {
code: "InvalidUtf8";
details: Readonly<{ cause: string }> & CborErrorDetails;
}
- Defined in error.ts:262

`Static`invalidDate

invalidDate(
    cause: string,
): CborError & {
    code: "InvalidDate";
    details: Readonly<{ cause: string }> & CborErrorDetails;
}
Invalid ISO 8601 / RFC 3339 date string (with the underlying reason).
Parameters
- cause: string
Returns CborError & {
code: "InvalidDate";
details: Readonly<{ cause: string }> & CborErrorDetails;
}
- Defined in error.ts:269

`Static`custom

custom(
    message: string,
): CborError & {
    code: "Custom";
    details: Readonly<unknown> & CborErrorDetails;
}
An arbitrary error carrying a custom message.
Parameters
- message: string
Returns CborError & { code: "Custom"; details: Readonly<unknown> & CborErrorDetails }
- Defined in error.ts:276

Class CborError

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CborError

Properties

Readonlycode

Readonlydetails

Methods

StaticisCborError

Parameters

Staticunderrun

Returns CborError & { code: "Underrun"; details: Readonly<unknown> & CborErrorDetails }

StaticunsupportedHeaderValue

Parameters

Returns CborError & { code: "UnsupportedHeaderValue"; details: Readonly<{ headerValue: number }> & CborErrorDetails;}

StaticnonCanonicalNumeric

Returns CborError & { code: "NonCanonicalNumeric"; details: Readonly<unknown> & CborErrorDetails;}

StaticinvalidSimpleValue

Returns CborError & { code: "InvalidSimpleValue"; details: Readonly<unknown> & CborErrorDetails;}

StaticinvalidString

Parameters

Returns CborError & { code: "InvalidString"; details: Readonly<{ cause: string }> & CborErrorDetails;}

StaticnonCanonicalString

Returns CborError & { code: "NonCanonicalString"; details: Readonly<unknown> & CborErrorDetails;}

StaticunusedData

Parameters

Returns CborError & { code: "UnusedData"; details: Readonly<{ count: number }> & CborErrorDetails;}

StaticmisorderedMapKey

Returns CborError & { code: "MisorderedMapKey"; details: Readonly<unknown> & CborErrorDetails;}

StaticduplicateMapKey

Returns CborError & { code: "DuplicateMapKey"; details: Readonly<unknown> & CborErrorDetails;}

StaticmissingMapKey

Returns CborError & { code: "MissingMapKey"; details: Readonly<unknown> & CborErrorDetails;}

StaticoutOfRange

Returns CborError & { code: "OutOfRange"; details: Readonly<unknown> & CborErrorDetails;}

StaticwrongType

Returns CborError & { code: "WrongType"; details: Readonly<unknown> & CborErrorDetails }

StaticwrongTag

Parameters

Returns CborError & { code: "WrongTag"; details: Readonly<{ expectedTag: Tag; actualTag: Tag }> & CborErrorDetails;}

StaticinvalidUtf8

Parameters

Returns CborError & { code: "InvalidUtf8"; details: Readonly<{ cause: string }> & CborErrorDetails;}

StaticinvalidDate

Parameters

Returns CborError & { code: "InvalidDate"; details: Readonly<{ cause: string }> & CborErrorDetails;}

Staticcustom

Parameters

Returns CborError & { code: "Custom"; details: Readonly<unknown> & CborErrorDetails }

Settings

On This Page

`Readonly`code

`Readonly`details

`Static`isCborError

`Static`underrun

`Static`unsupportedHeaderValue

Returns CborError & {
code: "UnsupportedHeaderValue";
details: Readonly<{ headerValue: number }> & CborErrorDetails;
}

`Static`nonCanonicalNumeric

Returns CborError & {
code: "NonCanonicalNumeric";
details: Readonly<unknown> & CborErrorDetails;
}

`Static`invalidSimpleValue

Returns CborError & {
code: "InvalidSimpleValue";
details: Readonly<unknown> & CborErrorDetails;
}

`Static`invalidString

Returns CborError & {
code: "InvalidString";
details: Readonly<{ cause: string }> & CborErrorDetails;
}

`Static`nonCanonicalString

Returns CborError & {
code: "NonCanonicalString";
details: Readonly<unknown> & CborErrorDetails;
}

`Static`unusedData

Returns CborError & {
code: "UnusedData";
details: Readonly<{ count: number }> & CborErrorDetails;
}

`Static`misorderedMapKey

Returns CborError & {
code: "MisorderedMapKey";
details: Readonly<unknown> & CborErrorDetails;
}

`Static`duplicateMapKey

Returns CborError & {
code: "DuplicateMapKey";
details: Readonly<unknown> & CborErrorDetails;
}

`Static`missingMapKey

Returns CborError & {
code: "MissingMapKey";
details: Readonly<unknown> & CborErrorDetails;
}

`Static`outOfRange

Returns CborError & {
code: "OutOfRange";
details: Readonly<unknown> & CborErrorDetails;
}

`Static`wrongType

`Static`wrongTag

Returns CborError & {
code: "WrongTag";
details: Readonly<{ expectedTag: Tag; actualTag: Tag }> & CborErrorDetails;
}

`Static`invalidUtf8

Returns CborError & {
code: "InvalidUtf8";
details: Readonly<{ cause: string }> & CborErrorDetails;
}

`Static`invalidDate

Returns CborError & {
code: "InvalidDate";
details: Readonly<{ cause: string }> & CborErrorDetails;
}

`Static`custom