collab

Aug 21, 2026

Changes in this version

+ var ErrPipeClosed = errors.New("collab: pipe closed")

+ func Pipe() (Transport, *PipeConn)

+ type PipeConn struct

type Server

+ func (s *Server) ServePipe(ctx context.Context, sc *PipeConn) error

Aug 20, 2026

Changes in this version

+ type ICEServerAuth struct — js/wasm

+ Credential string

+ URLs []string

+ Username string

type PeerConfig — js/wasm

+ ICEServersAuth []ICEServerAuth

Aug 20, 2026

Changes in this version

+ type Peer struct — js/wasm

+ func NewPeer(cfg PeerConfig) (*Peer, error)

+ func (p *Peer) AcceptAnswer(blob string) error

+ func (p *Peer) Answer(ctx context.Context, remoteOffer string) (string, error)

+ func (p *Peer) Close() error

+ func (p *Peer) DataChannel(ctx context.Context) (js.Value, error)

+ func (p *Peer) Offer(ctx context.Context, label string) (string, error)

+ type PeerConfig struct — js/wasm

+ ICEServers []string

Aug 18, 2026

Changes in this version

type Config — js/wasm

+ Clock func() time.Time

+ EvictAfter time.Duration

+ OnEvictError func(document string, err error)

+ PersistEvery time.Duration

+ type GRPCServer struct — darwin/amd64, linux/amd64, windows/amd64

+ func GRPCService(s *Server) *GRPCServer

+ func (g *GRPCServer) Session(stream collabpb.Collab_SessionServer) error

type Server — js/wasm

+ func (s *Server) Close(ctx context.Context) error

+ func (s *Server) ServeDataChannel(ctx context.Context, ch js.Value) error

type Transport — js/wasm

+ func DataChannel(ch js.Value) Transport

Aug 18, 2026

Changes in this version

type Server — darwin/amd64, linux/amd64, windows/amd64

+ func (s *Server) Follow(ctx context.Context, peer Transport, document string, as crdt.SiteID) error

Aug 17, 2026

Changes in this version

+ var ErrNoDocument = errors.New("collab: a document must have a name") — darwin/amd64, linux/amd64, windows/amd64

type Config — darwin/amd64, linux/amd64, windows/amd64

+ Clock func() time.Time

+ EvictAfter time.Duration

+ OnEvictError func(document string, err error)

+ PersistEvery time.Duration

+ type DirStore struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewDirStore(dir string) (*DirStore, error)

+ func (s *DirStore) Documents() ([]string, error)

+ func (s *DirStore) Load(_ context.Context, document string) ([]byte, error)

+ func (s *DirStore) Save(_ context.Context, document string, snapshot []byte) error

type Server — darwin/amd64, linux/amd64, windows/amd64

+ func (s *Server) Close(ctx context.Context) error

Aug 17, 2026

Changes in this version

type Text

+ func (t *Text) AnchorUTF16(pos int) (crdt.ID, error)

+ func (t *Text) AuthorRunsUTF16() []crdt.AuthorRun

+ func (t *Text) PositionUTF16(anchor crdt.ID) (pos int, ok bool)

Aug 17, 2026

Changes in this version

+ var ErrTransport = errors.New("collab: transport")

type Server — darwin/amd64, linux/amd64, windows/amd64

+ func (s *Server) ServeWebSocket(origins ...string) http.Handler

+ type Transport interface

+ func GRPC(conn grpc.ClientConnInterface) Transport

+ func WebSocket(url string, opts ...WebSocketOption) Transport

+ type WebSocketOption func(*wsTransport)

+ func WithHTTPHeader(h http.Header) WebSocketOption

Aug 17, 2026

Changes in this version

type Client

+ func (c *Client) List(name string) (*List, error)

+ func (c *Client) Map(name string) (*Map, error)

+ func (c *Client) Parts() []crdt.Part

+ type List struct

+ func (l *List) Append(values ...[]byte) error

+ func (l *List) Delete(pos, count int) error

+ func (l *List) Get(pos int) ([]byte, error)

+ func (l *List) Insert(pos int, values ...[]byte) error

+ func (l *List) Len() int

+ func (l *List) Name() string

+ func (l *List) Part() crdt.Part

+ func (l *List) Values() [][]byte

+ type Map struct

+ func (m *Map) Delete(key string) error

+ func (m *Map) Get(key string) ([]byte, bool)

+ func (m *Map) Keys() []string

+ func (m *Map) Len() int

+ func (m *Map) Name() string

+ func (m *Map) Part() crdt.Part

+ func (m *Map) Set(key string, value []byte) error

+ type Text struct

+ func (t *Text) Anchor(pos int) (crdt.ID, error)

+ func (t *Text) AuthorRuns() []crdt.AuthorRun

+ func (t *Text) Delete(pos, length int) error

+ func (t *Text) DeleteUTF16(pos, length int) error

+ func (t *Text) Insert(pos int, text string) error

+ func (t *Text) InsertUTF16(pos int, text string) error

+ func (t *Text) Len() int

+ func (t *Text) LenUTF16() int

+ func (t *Text) Name() string

+ func (t *Text) Part() crdt.Part

+ func (t *Text) Position(anchor crdt.ID) (int, bool)

+ func (t *Text) String() string

+ func (t *Text) Visible(anchor crdt.ID) bool

Aug 16, 2026

Changes in this version

type Client

+ func (c *Client) DeleteUTF16(pos, length int) error

+ func (c *Client) InsertUTF16(pos int, text string) error

+ func (c *Client) LenUTF16() int

Aug 16, 2026

Changes in this version

type Client

+ func (c *Client) Anchor(pos int) (crdt.ID, error)

+ func (c *Client) AuthorRuns() []crdt.AuthorRun

+ func (c *Client) Position(anchor crdt.ID) (int, bool)

+ func (c *Client) TakeChanges() []crdt.Change

+ func (c *Client) Visible(anchor crdt.ID) bool

Aug 16, 2026

Changes in this version

type Config

+ Authorize func(ctx context.Context, document string, site crdt.SiteID) error

Aug 16, 2026

Changes in this version

+ const DefaultBacklog

+ var ErrClosed = errors.New("collab: session closed")

+ var ErrProtocol = errors.New("collab: unexpected message from the server")

+ type Client struct

+ func Join(ctx context.Context, conn grpc.ClientConnInterface, cfg ClientConfig) (*Client, error)

+ func (c *Client) Changes() <-chan struct{}

+ func (c *Client) Close() error

+ func (c *Client) Delete(pos, length int) error

+ func (c *Client) Document() string

+ func (c *Client) Done() <-chan struct{}

+ func (c *Client) Err() error

+ func (c *Client) Insert(pos int, text string) error

+ func (c *Client) Len() int

+ func (c *Client) Peers() []awareness.Peer

+ func (c *Client) SetCursor(cursor awareness.Cursor, meta map[string]string) error

+ func (c *Client) Site() crdt.SiteID

+ func (c *Client) Snapshot() []byte

+ func (c *Client) Text() string

+ func (c *Client) Version() crdt.VersionVector

+ type ClientConfig struct

+ Document string

+ Resume []byte

+ Site crdt.SiteID

+ type Config struct

+ Backlog int

+ Store Store

+ type MemoryStore struct

+ func NewMemoryStore() *MemoryStore

+ func (s *MemoryStore) Documents() []string

+ func (s *MemoryStore) Load(_ context.Context, document string) ([]byte, error)

+ func (s *MemoryStore) Save(_ context.Context, document string, snapshot []byte) error

+ type Server struct

+ func NewServer(cfg Config) *Server

+ func (s *Server) Flush(ctx context.Context) error

+ func (s *Server) Session(stream collabpb.Collab_SessionServer) error

+ type Store interface

+ Load func(ctx context.Context, document string) ([]byte, error)

+ Save func(ctx context.Context, document string, snapshot []byte) error