order

• order<Model, Key>(field: Key): OrderQuery<Model, Key>
• order<Model, Key>(field: Key, cursors: Cursor<Model, Key>[]): OrderQuery<Model, Key>
• order<Model, Key>(field: Key, method: FirestoreOrderByDirection, cursors?: Cursor<Model, Key>[]): OrderQuery<Model, Key>

• Creates order query object with given field, ordering method and pagination cursors.

  import { order, query, limit, startAfter, collection } from 'typesaurus'
  
  type Contact = { name: string; year: number }
  const contacts = collection<Contact>('contacts')
  
  query(contacts, [
    order('year', 'asc', [startAfter(2000)]),
    //=> {
    //=>   type: 'order',
    //=>   field: 'year',
    //=>   method: 'asc',
    //=>   cursors: [{ method: 'startAt', value: 2000 }]
    //=> }
    limit(2)
  ]).then(bornAfter2000 => {
    console.log(bornAfter2000)
    //=> 420
  })

  Type parameters

  • Model

  • Key: keyof Model

  Parameters

  • field: Key

    Apply ascending order on given field

  Returns OrderQuery<Model, Key>

  The order query object

• Creates order query object with given field, ordering method and pagination cursors.

  import { order, query, limit, startAfter, collection } from 'typesaurus'
  
  type Contact = { name: string; year: number }
  const contacts = collection<Contact>('contacts')
  
  query(contacts, [
    order('year', 'asc', [startAfter(2000)]),
    //=> {
    //=>   type: 'order',
    //=>   field: 'year',
    //=>   method: 'asc',
    //=>   cursors: [{ method: 'startAt', value: 2000 }]
    //=> }
    limit(2)
  ]).then(bornAfter2000 => {
    console.log(bornAfter2000)
    //=> 420
  })

  Type parameters

  • Model

  • Key: keyof Model

  Parameters

  • field: Key

    Apply ascending order on given field with given cursors

  • cursors: Cursor<Model, Key>[]

    Cursors that define pagination rules (startAfter, startAt, endBefore and endAt)

  Returns OrderQuery<Model, Key>

  The order query object

• Creates order query object with given field, ordering method and pagination cursors.

  import { order, query, limit, startAfter, collection } from 'typesaurus'
  
  type Contact = { name: string; year: number }
  const contacts = collection<Contact>('contacts')
  
  query(contacts, [
    order('year', 'asc', [startAfter(2000)]),
    //=> {
    //=>   type: 'order',
    //=>   field: 'year',
    //=>   method: 'asc',
    //=>   cursors: [{ method: 'startAt', value: 2000 }]
    //=> }
    limit(2)
  ]).then(bornAfter2000 => {
    console.log(bornAfter2000)
    //=> 420
  })

  Type parameters

  • Model

  • Key: keyof Model

  Parameters

  • field: Key

    Apply the order to the field

  • method: FirestoreOrderByDirection

    Used ordering method ('desc' or 'asc')

  • Optional cursors: Cursor<Model, Key>[]

    Cursors that define pagination rules (startAfter, startAt, endBefore and endAt)

  Returns OrderQuery<Model, Key>

  The order query object