cbor-utils v0.11.24

CBOR Utils

This library provides you with low level tools to use CBOR format. It is inspired by minicbor crate in Rust and rxjs library in Javascript.

API Docs

To see the full API Documentation, please visit Docs.

Installation

Using npm:

npm install cbor-utils

Using jsr:

npx jsr add @whiteand/cbor

Example:

If you want to encode something to Uint8Array you can use encode function.

import { encode, u8, bytes, bool } from "cbor-utils";
const bytes = encode((e) => {
  e.encode(u8, 42);
  e.encode(bytes, new Uint8Array([1, 2, 3]));
  e.encode(bool, true);
});

If you want to decode something you can use decode function.

import { ok, decode, Result, u8, bytes, bool } from "cbor-utils";

/**
 * @type {Result<{id: number, hash: Uint8Array, submitted: boolean }, DecodingError>
 */
const res = decode(cborBytes, (d) => {
  const id = d.decode(u8);
  if (!id.ok()) return id;
  const hash = d.decode(bytes);
  if (!hash.ok()) return hash;
  const submitted = d.decode(bool);
  if (!submitted.ok()) return submitted;
  return ok({
    id: id.value,
    hash: hash.value,
    submitted: submitted.value,
  });
});

//or less type safe version, but without necessity to check each decoded item result:
import { tryDecode, u8, bytes, bool } from "cbor-utils";

/**
 * @type {Result<{id: number, hash: Uint8Array, submitted: boolean }, unknown>
 */
const result2 = tryDecode(cborBytes, (d) => {
  const id = d.decode(u8);
  const hash = d.decode(bytes);
  const submitted = d.decode(bool);

  return {
    id,
    hash,
    submitted,
  };
});

Terminology

CBOR Type

A CBOR Type is an object that allows you to encode and decode values of the specified type. Example: CBOR Type of u8 means that this object has encode capability that converts u8 into a CBOR data item, also it is able to read u8 data item from an Uint8Array.

Encoder

Is an object that allows you to encode values into a growing Uint8Array.

Decoder

Is an object that consists of two fields buf: Uint8Array and ptr: number. CBOR Types modify the decoder type to read cbor item.

Operator

Is a function that takes one CBOR Type (called source type) and returns another CBOR Type (called target type). Example: array operator takes CBOR Type of u8 and returns CBOR type of array<u8>.