Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiveQueryEventUpdate

Represents an update event describing all changes that occured for documents covered by a (live) query.

Hierarchy

  • LiveQueryEventUpdate

Index

Properties

Readonly deletions

deletions: number[]

The indexes into the array oldDocuments, which relate to a document that was in the previous most recent list of matching documents but is no longer a matching document.

Readonly insertions

insertions: number[]

The indexes in the array of matching documents that accompany this event, which relate to a document that was not in the previous most recent list of matching documents.

Readonly isInitial

isInitial: false = false

Whether or not this is the initial event being delivered. Always false for LiveQueryEventUpdate.

Readonly moves

moves: LiveQueryMove[]

Objects that describe how documents' positions in the list of matching documents have changed since the previous live query event.

Readonly oldDocuments

oldDocuments: Document[]

The documents that previously matched the query, before the latest event.

Readonly updates

updates: number[]

The indexes in the array of matching documents that accompany this event, which relate to a document that has been updated since the previous live query event.

Methods

hash

  • Returns a hash that represents the set of matching documents.

    Parameters

    Returns BigInt

hashMnemonic

  • hashMnemonic(documents: Document[]): string
  • Returns a pattern of words that together create a mnemonic, which represents the set of matching documents.

    Parameters

    Returns string