Skip to content

Documentation / @super-line/server / ServerCrdtCollectionHandle

Interface: ServerCrdtCollectionHandle<Doc> ​

Defined in: collections/types.ts:170

Server-authoritative handle for a CRDT document collection (srv.collection('scenes')). Creation is server-only (Q10): create validates the initial doc and materializes it; open returns a reactive co-writer whose mutations fan out like a relayed client delta. Policy-free (server is authoritative).

Type Parameters ​

Doc ​

Doc = unknown

Methods ​

create() ​

create(id, data): Promise<void>

Defined in: collections/types.ts:172

Create a document with pre-validated initial data. Throws CONFLICT if the id exists.

Parameters ​

id ​

string

data ​

Doc

Returns ​

Promise<void>


delete() ​

delete(id): Promise<void>

Defined in: collections/types.ts:178

Delete a document (idempotent), fanning the deletion cluster-wide.

Parameters ​

id ​

string

Returns ​

Promise<void>


list() ​

list(opts?): Promise<DocSummary[]>

Defined in: collections/types.ts:180

Enumerate document ids + summaries (no content query).

Parameters ​

opts? ​

DocListOpts

Returns ​

Promise<DocSummary[]>


open() ​

open(id, opts?): CrdtServerReplica

Defined in: collections/types.ts:174

Open a reactive co-writer over an existing document. origin (default "server") attributes its writes.

Parameters ​

id ​

string

opts? ​
origin? ​

string

Returns ​

CrdtServerReplica


read() ​

read(id): Promise<Doc | undefined>

Defined in: collections/types.ts:176

Read the current plaintext snapshot of a document, or undefined if absent.

Parameters ​

id ​

string

Returns ​

Promise<Doc | undefined>

Released under the MIT License.