Class GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

constructor

• new GroupedJoin<
      Aliases extends Record<string, string[]>,
      ReturnType extends Record<string, DocumentData>,
      RootAlias extends string,
      LatestAlias extends string,
  >(
      joinQueryBuilder: JoinQueryBuilder<
          Aliases,
          ReturnType,
          LatestAlias,
          RootAlias,
      >,
  ): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  internal

  Type Parameters

  • Aliases extends Record<string, string[]>
  • ReturnType extends Record<string, DocumentData>
  • RootAlias extends string
  • LatestAlias extends string

  Parameters

  • joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>

  Returns GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

ReadonlyjoinQueryBuilder

addCompositeCondition

• addCompositeCondition(
      conditions: SimpleCondition<
          any,
          string,
          | "in"
          | "not in"
          | "array_includes_some"
          | "array_includes_all"
          | "array_not_includes"
          | "=="
          | "!="
          | ">="
          | "<="
          | ">"
          | "<"
          | "like"
          | "not like"
          | "like_cs"
          | "not like_cs",
      >[],
  ): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  Parameters

  • conditions: SimpleCondition<
        any,
        string,
        | "in"
        | "not in"
        | "array_includes_some"
        | "array_includes_all"
        | "array_not_includes"
        | "=="
        | "!="
        | ">="
        | "<="
        | ">"
        | "<"
        | "like"
        | "not like"
        | "like_cs"
        | "not like_cs",
    >[]

  Returns GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  Inherit Doc

clone

• clone(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  Returns GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  Inherit Doc

dereference

• dereference(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>

  Dereferences the document references in the result of this query. For example, collection.query().snapshot() returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of the actual document data.

  Returns SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>

extractData

• extractData(
      data: Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>,
  ): any

  Parameters

  • data: Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>

  Returns any

  Inherit Doc

flipSortOrder

• flipSortOrder(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  Returns GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  Inherit Doc

getLimit

• getLimit(): number

  @internal/

  Returns number

getSortOrders

• getSortOrders(): FieldSort<any>[]

  Returns FieldSort<any>[]

  Inherit Doc

limit

• limit(limit: number): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

  @internal/

  Parameters

  • limit: number

  Returns GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>

paginate

• paginate(
      options?: Partial<PaginationOptions>,
  ): Pagination<
      Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>,
  >

  Enables pagination for the join query results.

  Parameters

  • Optionaloptions: Partial<PaginationOptions>

    Optional pagination configuration such as page size and cursor.

  Returns Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>

  A Pagination object for fetching paginated results.

peek

• peek(): Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>[]

  Returns the results of the query based on the data that is currently available on the client. This method is useful for synchronously accessing data that has already been fetched by another query. The method will return an empty array if data has not yet been populated.

  Returns Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>[]

  An array of query results.

serialize

• serialize(): SerializedJoinQuery

  Serializes the active query used by the emitter.

  Returns SerializedJoinQuery

snapshot

• snapshot(): Promise<
      Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>[],
  >

  Returns a promise that resolves to the query results.

  Returns Promise<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>[]>

  A promise that resolves to the query results.

snapshots

• snapshots(
      subscribe?: boolean,
  ): Observable<
      Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>[],
  >

  Returns an observable that emits the query results and updates whenever the query results change unless subscribe=false is provided.

  Important: Make sure to unsubscribe from the observable when you are done with it.

  Parameters

  • Optionalsubscribe: boolean

    Whether to subscribe to changes to the query results. Defaults to true.

  Returns Observable<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>[]>

  An observable for the query results.