API Reference

Complete API documentation is available in the TypeDoc-generated reference.

Packages

• @grounds/core - Low-level Relish wire format encoding and decoding
• @grounds/schema - TypeBox schema integration with compile-time validation
• @grounds/stream - Streaming utilities for encoding and decoding

What’s in the API Reference?

The API reference includes detailed documentation for all exported functions, classes, types, and interfaces:

• Function signatures with parameter types and return types
• Class constructors, methods, and properties
• Type aliases and interfaces
• Code examples and usage patterns
• Cross-references to related APIs

★ Tip: Use the search function in the API documentation (top-right) to quickly find specific functions, types, or classes.