Interface CborCodec<T>`Beta`

A two-way codec binding a TypeScript type T to its CBOR representation. The codec value is the runtime witness that justifies the generic in decodeWith - no unwitnessed casts.

Ship-with exemplar: CborDate.codec.

interface CborCodec<T> {
    tags?: readonly Tag[];
    decode(cbor: Cbor): T;
    encode(value: T): Cbor;
}

Type Parameters

T

Index

Properties

Methods

Properties

`Optional` `Readonly` `Beta`tags

tags?: readonly Tag[]

The tags this codec's encoding carries, if any (informational).

Methods

decode

decode(cbor: Cbor): T
Beta
Convert a decoded CBOR value to T.
Parameters
- cbor: Cbor
Returns T

Throws
on shape/tag mismatch.
- Defined in codable.ts:51

encode

encode(value: T): Cbor
Beta
Convert a T back to CBOR.
Parameters
- value: T
Returns Cbor
- Defined in codable.ts:53