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

    Class ByteString

    Represents a CBOR byte string (major type 2).

    Use Cases:

    • Binary data such as images, audio, or other non-text content
    • Cryptographic values like hashes, signatures, and public keys
    • Embedded CBOR (wrapped with tag 24)
    • Other serialized data formats embedded in CBOR
    // Creating a byte string from various sources
    const bytes1 = new ByteString(new Uint8Array([1, 2, 3, 4]));
    const bytes2 = ByteString.from([5, 6, 7, 8]);
    const bytes3 = ByteString.from(new Uint8Array([9, 10, 11, 12]));

    // Converting to and from CBOR
    const cborValue = bytes1.toCbor();

    // ByteString provides Uint8Array-like operations
    const bytes = new ByteString(new Uint8Array([1, 2]));
    bytes.extend(new Uint8Array([3, 4]));
    assert(bytes.byteLength === 4);
    assert.deepEqual(bytes.bytes, new Uint8Array([1, 2, 3, 4]));
    Index
    constructor
    [toStringTag] bytes byteLength
    from extend toUint8Array [iterator] toCbor fromHex toHex fromCbor at equals clone

    • Creates a new ByteString from a Uint8Array or array of bytes.

      Parameters

      • data: Uint8Array<ArrayBufferLike> | number[]

        The byte data

      Returns ByteString

      // From a Uint8Array
      const bytes1 = new ByteString(new Uint8Array([1, 2, 3, 4]));

      // From a number array
      const bytes2 = new ByteString(new Uint8Array([5, 6, 7, 8]));
    • get "[toStringTag]"(): string

      Debug label: Object.prototype.toString reports [object ByteString].

      Returns string

    • get bytes(): Uint8Array

      The underlying byte data (LIVE reference - mutations are visible to the ByteString; use toUint8Array() for a copy).

      Returns Uint8Array

    • get byteLength(): number

      The length of the byte string in bytes (typed-array vocabulary).

      Returns number

    • Creates a new ByteString from various input types.

      Parameters

      • data: string | Uint8Array<ArrayBufferLike> | number[]

        Uint8Array, number array, or string

      Returns ByteString

      New ByteString instance

      const bytes1 = ByteString.from([1, 2, 3, 4]);
      const bytes2 = ByteString.from(new Uint8Array([5, 6, 7, 8]));
      const bytes3 = ByteString.from("hello");

    • Extends the byte string with additional bytes.

      Parameters

      • other: Uint8Array<ArrayBufferLike> | number[]

        Bytes to append

      Returns void

      const bytes = new ByteString(new Uint8Array([1, 2]));
      bytes.extend(new Uint8Array([3, 4]));
      assert.deepEqual(bytes.bytes, new Uint8Array([1, 2, 3, 4]));

      // You can extend with different types
      bytes.extend([5, 6]);
      assert.deepEqual(bytes.bytes, new Uint8Array([1, 2, 3, 4, 5, 6]));

    • Creates a new Uint8Array containing a copy of the byte string's data.

      Returns Uint8Array<ArrayBuffer>

      Copy of the data

      const bytes = new ByteString(new Uint8Array([1, 2, 3, 4]));
      const arr = bytes.toUint8Array();
      assert.deepEqual(arr, new Uint8Array([1, 2, 3, 4]));

      // The returned array is a clone, so you can modify it independently
      const arr2 = bytes.toUint8Array();
      arr2[0] = 99;
      assert.deepEqual(bytes.bytes, new Uint8Array([1, 2, 3, 4])); // original unchanged

    • Iterate the bytes.

      Returns Iterator<number>

    • Converts the ByteString to a CBOR value.

      Returns Cbor

      CBOR byte string

      const bytes = new ByteString(new Uint8Array([1, 2, 3, 4]));
      const cborValue = bytes.toCbor();

    • Create a ByteString from a hex string. Inherits hexToBytes's validation: whitespace-tolerant, but throws CborError Custom on odd length or non-hex characters.

      Parameters

      • hex: string

      Returns ByteString

    • Render the bytes as lowercase hex.

      Returns string

    • Attempts to convert a CBOR value into a ByteString.

      Parameters

      • cbor: Cbor

        CBOR value

      Returns ByteString

      ByteString if successful

      Error if the CBOR value is not a byte string

      const cborValue = toCbor(new Uint8Array([1, 2, 3, 4]));
      const bytes = ByteString.fromCbor(cborValue);
      assert.deepEqual(bytes.bytes, new Uint8Array([1, 2, 3, 4]));

      // Converting from a different CBOR type throws
      const cborInt = toCbor(42);
      try {
        ByteString.fromCbor(cborInt); // throws
      } catch(e) {
        // Error: Wrong type
      }

    • Get element at index.

      Parameters

      • index: number

        Index to access

      Returns number | undefined

      Byte at index or undefined

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods