onQuery

• onQuery<Model>(collection: Collection<Model> | CollectionGroup<Model>, queries: Query<Model, keyof Model>[], onResult: function, onError?: undefined | function): function

• Subscribes to a collection query built using query objects ({@link order | order}, {@link where | where}, {@link limit | limit}).

  import { query, limit, order, startAfter, collection } from 'typesaurus'
  
  type Contact = { name: string; year: number }
  const contacts = collection<Contact>('contacts')
  
  onQuery(contacts, [
    order('year', 'asc', [startAfter(2000)]),
    limit(2)
  ], bornAfter2000 => {
    console.log(bornAfter2000)
    //=> 420
    console.log(bornAfter2000[0].ref.id)
    //=> '00sHm46UWKObv2W7XK9e'
    console.log(bornAfter2000[0].data)
    //=> { name: 'Sasha' }
  })

  Type parameters

  • Model

  Parameters

  • collection: Collection<Model> | CollectionGroup<Model>

    The collection or collection group to query

  • queries: Query<Model, keyof Model>[]

    The query objects

  • onResult: function

    The function which is called with the query result when the initial fetch is resolved or the query result updates.

    • • (docs: Doc<Model>[]): any

      • Parameters

        • docs: Doc<Model>[]

        Returns any

  • Optional onError: undefined | function

    The function is called with error when request fails.

  Returns function

  Function that unsubscribes the listener from the updates

  • • (): void

    • Returns void