# SonicWS TypeScript documentation

The TypeScript package is the primary Node and browser API for SonicWS. It exchanges packet schemas during the WebSocket handshake and delegates binary encoding, decoding, validation, batching, and raw DEFLATE to the Rust core. Node loads a native addon when available and falls back to WebAssembly; browsers use WebAssembly.

## Contents

- [Getting started](getting-started.md)
- [Packet schemas and every packet type](packets.md)
- [Client API](client.md)
- [Server and connection API](server.md)
- [Middleware](middleware.md)
- [Native core, browser bundle, and deployment](runtime.md)

## Public exports

`sonic-ws` exports `SonicWS`, `SonicWSConnection`, `SonicWSServer`, `PacketType`, `CreatePacket`, `CreateObjPacket`, `CreateEnumPacket`, `FlattenData`, `UnFlattenData`, `DefineEnum`, `WrapEnum`, `initializeWasmCore`, and the middleware types `BasicMiddleware`, `ConnectionMiddleware`, `ServerMiddleware`, and `BCInfo`.

The browser bundle exposes the browser `SonicWS` implementation and its helper methods. Internal files under `ws/util`, `native`, and `ws/debug` are not stable package entry points unless specifically exported above.