Class Query<AppModelType, DbModelType>Internal

converter

• get converter(): FirestoreDataConverter<AppModelType, DbModelType> | null

  Returns FirestoreDataConverter<AppModelType, DbModelType> | null

firestore

• get firestore(): FirestoreInternal

  Returns FirestoreInternal

constructor

• new Query<
      AppModelType = DocumentData,
      DbModelType extends DocumentData = DocumentData,
  >(
      firestore: FirestoreInternal,
      collectionPath: FirestorePath,
      modifiers: QueryModifiers,
      queryName?: string,
      converter?: FirestoreDataConverter<AppModelType, DbModelType> | null,
  ): Query<AppModelType, DbModelType>

  Type Parameters

  • AppModelType = DocumentData
  • DbModelType extends DocumentData = DocumentData

  Parameters

  • firestore: FirestoreInternal
  • collectionPath: FirestorePath
  • modifiers: QueryModifiers
  • OptionalqueryName: string
  • Optionalconverter: FirestoreDataConverter<AppModelType, DbModelType> | null

  Returns Query<AppModelType, DbModelType>

_handleQueryCursor

• _handleQueryCursor(
      cursor: "startAt" | "startAfter" | "endAt" | "endBefore",
      docOrField: default<AppModelType, DbModelType> | DocumentFieldValueInternal,
      fields: DocumentFieldValueInternal[],
  ): QueryModifiers

  Parameters

  • cursor: "startAt" | "startAfter" | "endAt" | "endBefore"
  • docOrField: default<AppModelType, DbModelType> | DocumentFieldValueInternal
  • fields: DocumentFieldValueInternal[]

  Returns QueryModifiers

count

• count(): AggregateQuery

  Returns AggregateQuery

countFromServer

• countFromServer(): AggregateQuery

  Returns AggregateQuery

endAt

• endAt(
      docOrField:
          | DocumentFieldValueInternal
          | default<DocumentData, DocumentData>,
      ...fields: DocumentFieldValueInternal[],
  ): Query<AppModelType, DbModelType>

  Parameters

  • docOrField: DocumentFieldValueInternal | default<DocumentData, DocumentData>
  • ...fields: DocumentFieldValueInternal[]

  Returns Query<AppModelType, DbModelType>

endBefore

• endBefore(
      docOrField:
          | DocumentFieldValueInternal
          | default<DocumentData, DocumentData>,
      ...fields: DocumentFieldValueInternal[],
  ): Query<AppModelType, DbModelType>

  Parameters

  • docOrField: DocumentFieldValueInternal | default<DocumentData, DocumentData>
  • ...fields: DocumentFieldValueInternal[]

  Returns Query<AppModelType, DbModelType>

get

• get(
      options?: { source?: "default" | "server" | "cache" },
  ): Promise<default<AppModelType, DbModelType>>

  Parameters

  • Optionaloptions: { source?: "default" | "server" | "cache" }

  Returns Promise<default<AppModelType, DbModelType>>

isEqual

• isEqual(other: Query<AppModelType, DbModelType>): boolean

  Parameters

  • other: Query<AppModelType, DbModelType>

  Returns boolean

limit

• limit(limit: number): Query<AppModelType, DbModelType>

  Parameters

  • limit: number

  Returns Query<AppModelType, DbModelType>

limitToLast

• limitToLast(limitToLast: number): Query<AppModelType, DbModelType>

  Parameters

  • limitToLast: number

  Returns Query<AppModelType, DbModelType>

onSnapshot

• onSnapshot(...args: unknown[]): () => void

  Parameters

  • ...args: unknown[]

  Returns () => void

orderBy

• orderBy(
      fieldPath: string | FieldPath,
      directionStr?: string,
  ): Query<AppModelType, DbModelType>

  Parameters

  • fieldPath: string | FieldPath
  • OptionaldirectionStr: string

  Returns Query<AppModelType, DbModelType>

startAfter

• startAfter(
      docOrField:
          | default<AppModelType, DbModelType>
          | DocumentFieldValueInternal,
      ...fields: DocumentFieldValueInternal[],
  ): Query<AppModelType, DbModelType>

  Parameters

  • docOrField: default<AppModelType, DbModelType> | DocumentFieldValueInternal
  • ...fields: DocumentFieldValueInternal[]

  Returns Query<AppModelType, DbModelType>

startAt

• startAt(
      docOrField:
          | default<AppModelType, DbModelType>
          | DocumentFieldValueInternal,
      ...fields: DocumentFieldValueInternal[],
  ): Query<AppModelType, DbModelType>

  Parameters

  • docOrField: default<AppModelType, DbModelType> | DocumentFieldValueInternal
  • ...fields: DocumentFieldValueInternal[]

  Returns Query<AppModelType, DbModelType>

where

• where(
      fieldPathOrFilter: string | FieldPath | _Filter,
      opStr?: string,
      value?: DocumentFieldValueInternal,
  ): Query<AppModelType, DbModelType>

  Parameters

  • fieldPathOrFilter: string | FieldPath | _Filter
  • OptionalopStr: string
  • Optionalvalue: DocumentFieldValueInternal

  Returns Query<AppModelType, DbModelType>

withConverter

• withConverter(converter: null): Query<DocumentData, DocumentData>

  Parameters

  • converter: null

  Returns Query<DocumentData, DocumentData>

• withConverter<
      NewAppModelType,
      NewDbModelType extends DocumentData = DocumentData,
  >(
      converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>,
  ): Query<NewAppModelType, NewDbModelType>

  Type Parameters

  • NewAppModelType
  • NewDbModelType extends DocumentData = DocumentData

  Parameters

  • converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>

  Returns Query<NewAppModelType, NewDbModelType>

_collectionPath

_converter

_firestore

_modifiers

_queryName

Readonlytype