cbor

import {encode, decode} from 'mikro/cbor'

Encode and decode CBORConcise Binary Object Representation, a compact binary format similar to JSONJavaScript Object Notation but smaller and faster to parse. Used internally by the kv storage module.

encode(value)

encode(value: unknown): Result<Uint8Array, CborError>

Encode a JavaScript value to CBORConcise Binary Object Representation bytes.

Supported types: number, string, boolean, null, undefined, Uint8Array, arrays, and plain objects with string keys. Functions, symbols, classes, and circular references are not supported.

const bytes = encode({temp: 22.5, humidity: 65}).orPanic('encode failed')
// bytes is a Uint8Array

decode(data)

decode(data: Uint8Array): Result<unknown, CborError>

Decode CBORConcise Binary Object Representation bytes back to a JavaScript value.

const bytes = encode(42).orPanic('encode')
const value = decode(bytes).orPanic('decode')
// value is 42

CborError

Variant	When
EncodeFailed	Value contains a type that can't be CBORConcise Binary Object Representation-encoded
DecodeFailed	Input bytes are not valid CBORConcise Binary Object Representation