Interface ListenOptions

Options for listening to real-time updates. Used with client.listen() to subscribe to document changes.

interface ListenOptions {
    effectFormat?: "mendoza";
    events?: ListenEventName[];
    includeAllVersions?: boolean;
    includeMutations?: boolean;
    includePreviousRevision?: boolean;
    includeResult?: boolean;
    tag?: string;
    visibility?: "query" | "transaction";
}

Properties

effectFormat? events? includeAllVersions? includeMutations? includePreviousRevision? includeResult? tag? visibility?

Properties

OptionaleffectFormat

effectFormat?: "mendoza"

Format for mutation effects. 'mendoza' includes apply and revert arrays.

Optionalevents

events?: ListenEventName[]

Event types to include in the observable.

Default Value

['mutation']

Optional InternalincludeAllVersions

includeAllVersions?: boolean

OptionalincludeMutations

includeMutations?: boolean

Whether to include the mutations that were performed. Set to false to reduce bandwidth if you only need the final document.

Default Value

true

OptionalincludePreviousRevision

includePreviousRevision?: boolean

Whether to include the document state before the mutation. Useful for tracking what changed.

Default Value

false

OptionalincludeResult

includeResult?: boolean

Whether to include the resulting document in addition to mutations. Set to false to reduce bandwidth if you only need mutation info.

Default Value

true

Optionaltag

tag?: string

Optional tag to identify the listener in logs

Optionalvisibility

visibility?: "query" | "transaction"

When to send events:

  • 'transaction': As soon as transaction is committed (default)
  • 'query': Only after changes are visible to queries

Default Value

'transaction'

Settings

Member Visibility

On This Page

Properties