Options
All
  • Public
  • Public/Protected
  • All
Menu

Query class that represents a Firestore query.

Hierarchy

  • Query

Indexable

[key: string]: any

Query class that represents a Firestore query.

Index

Constructors

Methods

Object literals

Constructors

constructor

Methods

endAt

from

  • from(val: QueryOptions["from"]): this
  • Adds a collection to query.

    Parameters

    • val: QueryOptions["from"]

    Returns this

limit

  • limit(number: number): this
  • Parameters

    • number: number

    Returns this

offset

  • offset(number: number): this
  • Parameters

    • number: number

    Returns this

orderBy

  • orderBy(order: QueryOptions["orderBy"], dir?: OrderOption["direction"]): this
  • Parameters

    • order: QueryOptions["orderBy"]
    • Default value dir: OrderOption["direction"] = "asc"

    Returns this

run

  • run(): Promise<any>

select

  • select(fields: QueryOptions["select"]): void
  • Parameters

    • fields: QueryOptions["select"]

    Returns void

startAt

toJSON

  • toJSON(): { structuredQuery: any }
  • Returns { structuredQuery: any }

    • structuredQuery: any

where

  • where(fieldPath: QueryOptions["where"]): this
  • Parameters

    • fieldPath: QueryOptions["where"]

    Returns this

Object literals

Readonly options

options: object

orderBy

orderBy: never[] = []

select

select: never[] = []

where

where: never[] = []

Legend

Generated using TypeDoc