Class QuerySnapshot<T>

constructor

• new QuerySnapshot<T = any>(
      snaps: QueryDocumentSnapshot<T>[],
      query: Query<T>,
      metadata: SnapshotMetadata,
  ): QuerySnapshot<T>

  Creates a new QuerySnapshot instance.

  Type Parameters

  • T = any

  Parameters

  • snaps: QueryDocumentSnapshot<T>[]

    Array of document snapshots.

  • query: Query<T>

    Underlying query.

  • metadata: SnapshotMetadata

    Snapshot metadata.

  Returns QuerySnapshot<T>

Readonlydocs

Readonlyempty

Readonlymetadata

Readonlyquery

Readonlysize

docChanges

• docChanges(
      options?: { includeMetadataChanges: boolean },
  ): {
      doc: QueryDocumentSnapshot<T>;
      newIndex: number;
      oldIndex: number;
      type: "removed" | "added" | "modified";
  }[]

  Returns an array of document changes.

  Parameters

  • Optionaloptions: { includeMetadataChanges: boolean }

    Options for changes.

  Returns {
      doc: QueryDocumentSnapshot<T>;
      newIndex: number;
      oldIndex: number;
      type: "removed" | "added" | "modified";
  }[]

  Array of document changes.

  • doc: QueryDocumentSnapshot<T>

    The document affected by this change.

  • newIndex: number

    The index of the changed document in the result set immediately after this DocumentChange (i.e. supposing that all prior DocumentChange objects have been applied). -1 for 'removed' events.

  • oldIndex: number

    The index of the changed document in the result set immediately prior to this DocumentChange (i.e. supposing that all prior DocumentChange objects have been applied). -1 for 'added' events.

  • type: "removed" | "added" | "modified"

    The type of change ('added', 'modified', or 'removed').

forEach

• forEach(
      callback: (result: QueryDocumentSnapshot<T>) => void,
      thisArg?: any,
  ): void

  Enumerates all of the documents in the QuerySnapshot.

  Parameters

  • callback: (result: QueryDocumentSnapshot<T>) => void

    Callback function to execute for each document.

  • OptionalthisArg: any

  Returns void

isEqual

• isEqual(snap: QuerySnapshot<T>): boolean

  Checks whether this QuerySnapshot is equal to the provided one.

  Parameters

  • snap: QuerySnapshot<T>

    Snapshot to compare.

  Returns boolean

  True if equal, false otherwise.

  Throws

  Throws an error if snap is not a QuerySnapshot instance.