Interface: CollabAuthorityConfig<Transaction>

Defined in: packages/collab-server/src/index.ts:32

The config for creating a CollabAuthority. Parameters that perform database operations should use the provided transaction or if a transaction is not provided, start a transaction and perform all database operations inside it.

Type Parameters

Transaction

Transaction

Properties

broadcastManager

broadcastManager: {
  broadcastCommit: (docId: string, commit: CommitJSON) => Promise<void>;
  createCommitListener: (docId: string, version: number) => Promise<CommitListener>;
}

Defined in: packages/collab-server/src/index.ts:89

The broadcast manager that will be used to listen for and send document updates.

Currently the only built-in option is the RedisBroadcastManager.

broadcastCommit

broadcastCommit: (docId: string, commit: CommitJSON) => Promise<void>;

Parameters

docId

string

commit

CommitJSON

Returns

Promise<void>

createCommitListener

createCommitListener: (docId: string, version: number) => Promise<CommitListener>;

Parameters

docId

string

version

number

Returns

Promise<CommitListener>

getCommit

getCommit: (tr: Transaction | null, docId: string, commitRef: string) => Promise<CommitJSON | null>;

Defined in: packages/collab-server/src/index.ts:53

Given a docId and commitRef, retrieves the associated commit's steps and version from your database and returns a joined CommitJSON object.

Parameters

tr

Transaction | null

docId

string

commitRef

string

Returns

Promise<CommitJSON | null>

getCommits

getCommits: (tr: Transaction | null, docId: string, version: number) => Promise<CommitJSON[]>;

Defined in: packages/collab-server/src/index.ts:61

For the provided docId, retrieves all commits from the database with a version number strictly greater than the provided version.

Parameters

tr

Transaction | null

docId

string

version

number

Returns

Promise<CommitJSON[]>

getDoc

getDoc: (tr: Transaction | null, docId: string) =>
  Promise<{
    docJSON: NodeJSON;
    lastUpdatedTimestamp: number;
    version: number;
  }>;

Defined in: packages/collab-server/src/index.ts:41

Retrieves a document from your database by docId.

Parameters

tr

Transaction | null

docId

string

Returns

Promise<{ docJSON: NodeJSON; lastUpdatedTimestamp: number; version: number; }>

runWithTransaction

runWithTransaction: <Result>(callback: (tr: Transaction) => Promise<Result>) => Promise<Result>;

Defined in: packages/collab-server/src/index.ts:37

This function should start a transaction on your database, execute the provided callback with it, and commit the transaction.

saveCommit: (
  tr: Transaction | null,
  docId: string,
  ref: string,
  version: number,
  steps: {
    [key: string]: unknown;
  }[],
) => Promise<void>;

Defined in: packages/collab-server/src/index.ts:75

Saves a commit along with its version and ref to your database.

saveDoc: (
  tr: Transaction | null,
  docId: string,
  docJSON: NodeJSON,
  version: number,
  lastUpdatedTimestamp: number,
) => Promise<void>;

Defined in: packages/collab-server/src/index.ts:65

Saves a document along with its docId, version, and lastUpdatedTimestamp to your database.

schema: Schema;

Defined in: packages/collab-server/src/index.ts:33

CollabAuthorityConfig

On this page