Type Alias Error

Type Declaration

• { type: "Underrun" }

  The CBOR data ended prematurely during decoding, before a complete CBOR item could be decoded. This typically happens when a CBOR item's structure indicates more data than is actually present.

• { type: "UnsupportedHeaderValue"; value: number }

  An unsupported or invalid value was encountered in a CBOR header byte. The parameter contains the unsupported header byte value. This can occur when decoding CBOR that uses unsupported features or is malformed.

• { type: "NonCanonicalNumeric" }

  A CBOR numeric value was encoded in a non-canonical form, violating the deterministic encoding requirement of dCBOR (per Section 2.3 of the dCBOR specification).

  This error is triggered when:

  • An integer is not encoded in its shortest possible form
  • A floating point value that could be represented as an integer was not reduced
  • A NaN value was not encoded in its canonical form (f97e00)
• { type: "InvalidSimpleValue" }

  An invalid CBOR simple value was encountered during decoding.

  Per Section 2.4 of the dCBOR specification, only false, true, null, and floating point values are valid simple values in dCBOR. All other major type 7 values are invalid.

• { type: "InvalidString"; message: string }

  A CBOR text string was not valid UTF-8. The parameter contains the specific error message.

  All CBOR text strings (major type 3) must be valid UTF-8 per RFC 8949.

• { type: "NonCanonicalString" }

  A CBOR text string was not encoded in Unicode Canonical Normalization Form C (NFC).

  Per Section 2.5 of the dCBOR specification, all text strings must be in NFC form, and decoders must reject any encoded text strings that are not in NFC.

• { type: "UnusedData"; count: number }

  The decoded CBOR item didn't consume all input data. The parameter contains the number of unused bytes.

  This error occurs when decoding functions expect exactly one CBOR item but the input contains additional data after a valid CBOR item.

• { type: "MisorderedMapKey" }

  The keys in a decoded CBOR map were not in the canonical lexicographic order of their encoding.

  Per the CDE specification and Section 2.1 of dCBOR, map keys must be in ascending lexicographic order of their encoded representation for deterministic encoding.

• { type: "DuplicateMapKey" }

  A decoded CBOR map contains duplicate keys, which is invalid.

  Per Section 2.2 of the dCBOR specification, CBOR maps must not contain duplicate keys, and decoders must reject encoded maps with duplicate keys.

• { type: "MissingMapKey" }

  A requested key was not found in a CBOR map during data extraction.

• { type: "OutOfRange" }

  A CBOR numeric value could not be represented in the specified target numeric type.

  This occurs when attempting to convert a CBOR number to a numeric type that is too small to represent the value without loss of precision.

• { type: "WrongType" }

  The CBOR value is not of the expected type for a conversion or operation.

  This occurs when attempting to convert a CBOR value to a type that doesn't match the actual CBOR item's type (e.g., trying to convert a string to an integer).

• { type: "WrongTag"; expected: Tag; actual: Tag }

  The CBOR tagged value had a different tag than expected. Contains the expected tag and the actual tag found.

• { type: "InvalidUtf8"; message: string }

  Invalid UTF‑8 in a text string.

• { type: "InvalidDate"; message: string }

  Invalid ISO 8601 date format.

• { type: "Custom"; message: string }

  Custom error message.