Sync / foldkit-sync/journal

Reaction

interface · packages/sync/src/serverJournal.ts:97

interface Reaction<Document, out R = never> {
  readonly sync: Document
  readonly name: string
  readonly on: ReadonlySet<string>
  readonly appends: ReadonlySet<string>
  readonly requires?: () => R
}

One declared reaction of one document: what it runs on, what it may append, and what its handler needs. Made by reaction, given to serverJournal.

Members

Reaction.sync

property · packages/sync/src/serverJournal.ts:99

readonly sync: Document

The contract it was declared for: serverJournal refuses it for another.

Reaction.name

property · packages/sync/src/serverJournal.ts:100

readonly name: string

Reaction.on

property · packages/sync/src/serverJournal.ts:102

readonly on: ReadonlySet<string>

The tags it runs on.

Reaction.appends

property · packages/sync/src/serverJournal.ts:104

readonly appends: ReadonlySet<string>

The tags it may append.

Reaction.requires

property · packages/sync/src/serverJournal.ts:106

readonly requires?: () => R

The services its handler needs; never present.