Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiveQuery

The type that is returned when calling observe() on a PendingCursorOperation object. It handles the logic for calling the event handler that is provided to observe calls.

LiveQuery objects must be kept in scope for as long as you wish to have your event handler be called when there is an update to a document matching the query you provide. When you no longer want to receive updates about documents matching a query then you must call stop().

Hierarchy

  • LiveQuery

Index

Properties

Accessors

Methods

Properties

Readonly query

query: string

The query that the live query is based on.

Readonly queryArgs

queryArgs: QueryArguments

The arguments belonging to query.

Accessors

collectionName

  • get collectionName(): string
  • The name of the collection that the live query is based on.

    Returns string

Methods

stop

  • stop(): void
  • Stop the live query from delivering updates.

    Returns void