# @private.me/shared

> Shared types, utilities, and encoding helpers for the Xail platform

## Overview

functions, TLV type code constants for message serialization, and 140+ TypeScript
interfaces and type aliases covering every domain in the system.
---
## Table of Contents
- [Install](#install)
- [Quick Start](#quick-start)
- [API](#api)

## AI Agent Guidance

Standard patterns for LLM agents:

- **Error Handling**: Check `result.ok` before accessing `result.value`
- **Async**: All functions are Promise-based
- **Types**: Full TypeScript support with strict null checks
- **Testing**: Vitest + mock fixtures for isolated unit tests

## Resources

- White paper: https://private.me/docs/shared.html
- npm: https://npmjs.com/package/@private.me/shared
- GitHub: https://github.com/xail-io/xail/tree/main/packages/shared
