Class Query<T>

Firestorm representation of a query. Queries can be chained together, as per the standard firestore SDK.

Type parameters

T: Entity

The entity for the query.

Hierarchy

Query

Implements

IQuery<T>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Query(Entity: object, collection: ICollection<T>, fields: Map<string, IFieldMeta>, native: Query): Query

- Defined in Query.ts:15
Create a collection query for an Entity.

Parameters
- Entity: object
  
  T The entity to represent.
- collection: ICollection<T>
  
  The collection to query.
- fields: Map<string, IFieldMeta>
  
  The list of field for the collection.
- native: Query
  
  The native firestore query.
Returns Query

Properties

Private _Entity

_Entity: object

Type declaration

Private _collection

_collection: ICollection<T>

Private _fields

_fields: Map<string, IFieldMeta>

Private _native

_native: Query

Methods

Private appendNativeQuery

appendNativeQuery(query: Query): Query<T>

- Defined in Query.ts:130
Appends a query to the current query.

Parameters
- query: Query
  
  The query to append.
Returns Query<T>

Private buildSnapshot

buildSnapshot(nativeSnapshot: QuerySnapshot): QuerySnapshot<T>

- Defined in Query.ts:143
Creates a firestorm snapshot from the firestore snapshot.

Parameters
- nativeSnapshot: QuerySnapshot
  
  The native query document snapshot.
Returns QuerySnapshot<T>

endAt

endAt(...fieldValues: any[]): Query<T>

Implementation of IQuery.endAt
- Defined in Query.ts:91
Applies an end at filter to the query.

Parameters
- Rest ...fieldValues: any[]
  
  The field values to end this query at, in order of the query's order by.
Returns Query<T>

endBefore

endBefore(...fieldValues: any[]): Query<T>

Implementation of IQuery.endBefore
- Defined in Query.ts:99
Applies an end before filter to the query.

Parameters
- Rest ...fieldValues: any[]
  
  The field values to end this query before, in order of the query's order by.
Returns Query<T>

get

get(): Promise<QuerySnapshot<T>>

Implementation of IQuery.get
- Defined in Query.ts:118
Returns Promise<QuerySnapshot<T>>

limit

limit(amount: number): Query<T>

Implementation of IQuery.limit
- Defined in Query.ts:67
Applies a limit filter to the query.

Parameters
- amount: number
  
  The maximum number of documents to return.
Returns Query<T>

onSnapshot

onSnapshot(onNext: function, onError?: undefined | function): function

- Defined in Query.ts:109
Attaches a listener to the query.

Parameters
- onNext: function
  
  Callback which is called when new snapshot is available.
  - - (snapshot: QuerySnapshot<T>): void
    - Parameters
      - snapshot: QuerySnapshot<T>
      Returns void
- Optional onError: undefined | function
  
  Callback which is called when an error occurs.
Returns function

An unsubscribe function.
- - (): void
  - Returns void

orderBy

orderBy(property: keyof T, sort?: firestore.OrderByDirection): Query<T>

Implementation of IQuery.orderBy
- Defined in Query.ts:55
Applies an order by filter to the query.

Parameters
- property: keyof T
  
  The property to order by.
- Optional sort: firestore.OrderByDirection
  
  The order direction. Default value is ascending.
Returns Query<T>

startAfter

startAfter(...fieldValues: any[]): Query<T>

Implementation of IQuery.startAfter
- Defined in Query.ts:83
Applies a start after filter to the query.

Parameters
- Rest ...fieldValues: any[]
  
  The field values to start this query after, in order of the query's order by.
Returns Query<T>

startAt

startAt(...fieldValues: any[]): Query<T>

Implementation of IQuery.startAt
- Defined in Query.ts:75
Applies a start at filter to the query.

Parameters
- Rest ...fieldValues: any[]
  
  The field values to start this query at, in order of the query's order by.
Returns Query<T>

where

where(property: keyof T, op: firestore.WhereFilterOp, value: any): Query<T>

Implementation of IQuery.where
- Defined in Query.ts:42
Applies a where filter to the query.

Parameters
- property: keyof T
  
  The property to query.
- op: firestore.WhereFilterOp
  
  The operation to apply.
- value: any
  
  The value to test for.
Returns Query<T>

Generated using TypeDoc