Properties

docs

non-null Array of non-null firebase.firestore.QueryDocumentSnapshot

An array of all the documents in the QuerySnapshot.

empty

boolean

True if there are no documents in the QuerySnapshot.

metadata

non-null firebase.firestore.snapshotMetadata

Metadata about this snapshot, concerning its source and if it has local modifications.

query

non-null firebase.firestore.query

The query you called get or onSnapshot on to get the QuerySnapshot.

size

number

The number of documents in the QuerySnapshot.

Methods

docChanges

docChanges(options)

Returns an array of the document changes since the last snapshot. If this is the first snapshot, all documents will be in the list as "added" changes.

Parameter

options

Optional

firebase.firestore.SnapshotOptions

Options that control whether metadata-only changes (i.e. only DocumentSnapshot.metadata changed) should be included.

forEach

forEach(callback, thisArg)

Enumerates all of the documents in the QuerySnapshot.

Parameter

callback

function(non-null firebase.firestore.QueryDocumentSnapshot)

thisArg

Optional

any type

The this binding for the callback.

isEqual

isEqual(other) returns boolean

Returns 'true' if this QuerySnapshot is equal to the provided one.

Parameter

other

firebase.firestore.QuerySnapshot

The QuerySnapshot to compare against.

Value must not be null.

Returns

boolean 'true' if this QuerySnapshot is equal to the provided one.