Module @grounds/core

Low-level Relish wire format implementation for encoding and decoding binary data.

This package provides type-safe value construction, encoding to bytes, and decoding back to JavaScript values following the Relish binary serialization specification.

Example

Quick start - encoding:

import { encode, U32, String_, Struct } from '@grounds/core';

const user = Struct(new Map([
  [0, String_('Alice')],
  [1, U32(25)]
]));

encode(user).match(
  (bytes) => {
    console.log('Encoded:', bytes.length, 'bytes');
  },
  (error) => console.error('Encoding failed:', error.message)
);

Example

Quick start - decoding:

import { decode } from '@grounds/core';

const bytes = new Uint8Array([...]); // from network or storage

decode(bytes).match(
  (value) => {
    console.log('Decoded:', value);
  },
  (error) => {
    if (error.code === 'UNEXPECTED_EOF') {
      console.error('Incomplete data');
    }
  }
);

Remarks

This package implements the low-level wire format only. For type-safe schema validation and TypeBox integration, use @grounds/schema. For streaming encoding and decoding, use @grounds/stream.

Key characteristics: