collaboration/hocuspocus - pro

Server-backed convenience wrapper: one owned Hocuspocus room over the full-document collaboration replica.

Functions (3)

Create a cryptographically strong room identifier. It is not an authorization token.

declare function createCollaborationRoomId(): string;

Create one owned Hocuspocus room and provider-neutral collaboration session.

declare function createHocuspocusCollaboration(options: CreateHocuspocusCollaborationOptions): Promise<HocuspocusCollaborationRoom>;

Validate and normalize a room identifier from a host interface.

declare function validateRoomId(value: string): string;

Options for the owned Hocuspocus collaboration convenience wrapper.

interface CreateHocuspocusCollaborationOptions

Member	Type	Summary
bootstrap	`CollaborationBootstrap`	Whether to seed the room, join it, or let the peers decide.
identity	`CollaborationIdentity`	The local participant. Recorded as the author of this replica's changes.
offlineEditing?	`boolean`	Admit local edits while the transport is `disconnected`. Buffered updates merge on reconnect. On by default; pass `false` to pause editing while disconnected. See [CreateDocumentCollaborationOptions.offlineEditing](CreateDocumentCollaborationOptions.offlineEditing).
roomId	`string`	Room name on the server, also the document id. Make one with `createCollaborationRoomId`.
syncedTimeoutMs?	`number`	Bound on the wait for the server's initial sync in the `join` and `create-or-join` flows. Default 30000 ms. On expiry the factory destroys everything it owns and rejects with the failure code `initialization-timeout`.
token?	`string \| (() => string \| Promise<string>)`	Authentication token the provider sends in its auth handshake. The server queues all traffic until that message arrives, so the provider always sends one; omit this and it sends an empty token. Pass a callback and the provider re-evaluates it on every reconnect, which is how expiring JWTs renew.
url	`string`	Hocuspocus server WebSocket URL, for example `wss://collab.example.test`.

Owned Hocuspocus provider and provider-neutral collaboration resources.

interface HocuspocusCollaborationRoom extends DocumentCollaborationHandle

Member	Type	Summary
provider	`HocuspocusProvider`	The connected provider. `destroy()` destroys it.
ydoc	`Y.Doc`	The room's Yjs document. `destroy()` destroys it.