Class LiveQueryEventInitial

First event fired immediately after registering a live query without any mutations. All subsequent events are of type LiveQueryEventUpdate.

Hierarchy

LiveQueryEventInitial

Index

Constructors

Properties

Methods

hash hashMnemonic

Constructors

constructor

new LiveQueryEventInitial(): LiveQueryEventInitial
Returns LiveQueryEventInitial

Properties

`Readonly` isInitial

isInitial: true = true

Whether or not this is the initial event being delivered. Always true for LiveQueryEventInitial.

Methods

hash

hash(documents: Document[]): BigInt
Returns a hash that represents the set of matching documents.
Parameters
- documents: Document[]
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
- documents: Document[]
Returns string