API Reference

This reference is generated from Gleam's docs metadata for beryl, beryl_ewe, and beryl_mist.

Generated content

Pages under /reference/api/ are generated from Gleam's docs metadata and reflect every public type, function, and constant. This is beryl's canonical API reference — beryl is not published to Hex yet, so there is no hexdocs.pm listing.

beryl 0.0.1

Module	Description
beryl	beryl - Type-safe real-time communication
beryl/bridge	Bridge - Forward an external OTP actor's message stream to a socket channel.
beryl/channel	Channel - Topic-based message callbacks
beryl/error	Shared beryl-owned error helpers.
beryl/group	Channel Groups - Named collections of topics for multi-topic broadcasting
beryl/presence	Presence - Distributed presence tracking backed by a CRDT
beryl/presence/wire	Phoenix-compatible wire encoding for presence diffs.
beryl/pubsub	PubSub - Distributed publish/subscribe using Erlang pg
beryl/socket	Socket - Connected client with typed state
beryl/stats	Local coordinator statistics.
beryl/supervisor	OTP supervision tree for beryl subsystems.
beryl/topic	Topic - Pattern matching for channel routing
beryl/transport	Transport SPI — the contract between beryl core and WebSocket transport
beryl/wire	Phoenix Wire Protocol — encoding/decoding helpers and the canonical
beryl/wire/codec	Pluggable wire codec for beryl.

beryl_ewe 0.0.1

Module	Description
beryl_ewe	Ewe WebSocket Transport - Direct Ewe integration for beryl

beryl_mist 0.0.1

Module	Description
beryl_mist	Mist WebSocket Transport - Direct Mist integration for beryl