Type Alias Codec<T>

Type-safe codec for schema-driven encoding and decoding.

Combines a schema with encode/decode operations, ensuring type safety through TypeScript's Static type inference.

type Codec<T> = {
    encode(value: T): Result<Uint8Array<ArrayBufferLike>, EncodeError>;
    decode(bytes: Uint8Array): Result<T, DecodeError>;
    schema: TRelishSchema;
}

Type Parameters

T

Index

Properties

Methods

Properties

schema

schema: TRelishSchema

The schema this codec is based on.

Methods

encode

encode(value: T): Result<Uint8Array<ArrayBufferLike>, EncodeError>
Encodes a typed value to bytes.
Parameters
- value: T
Returns Result<Uint8Array<ArrayBufferLike>, EncodeError>

decode

decode(bytes: Uint8Array): Result<T, DecodeError>
Decodes bytes to a typed value.
Parameters
- bytes: Uint8Array
Returns Result<T, DecodeError>