Methods

data

data(options) returns (firebase.firestore.Firestore~DocumentData or undefined)

Retrieves all fields in the document as an Object. Returns undefined if the document doesn't exist.

By default, FieldValue.serverTimestamp() values that have not yet been set to their final value will be returned as null. You can override this by passing an options object.

Parameter

options

Optional

firebase.firestore.SnapshotOptions

An options object to configure how data is retrieved from the snapshot (e.g. the desired behavior for server timestamps that have not yet been set to their final value).

Value must not be null.

Returns

(non-null firebase.firestore.Firestore~DocumentData or undefined) An object containing all fields in the specified document or 'undefined' if the document doesn't exist.

get

get(fieldPath, options) returns (any type or undefined)

Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.

By default, a FieldValue.serverTimestamp() that has not yet been set to its final value will be returned as null. You can override this by passing an options object.

Parameter

fieldPath

(string or non-null firebase.firestore.FieldPath)

The path (e.g. 'foo' or 'foo.bar') to a specific field.

options

Optional

firebase.firestore.SnapshotOptions

An options object to configure how the field is retrieved from the snapshot (e.g. the desired behavior for server timestamps that have not yet been set to their final value).

Value must not be null.

Returns

(any type or undefined) The data at the specified field location or undefined if no such field exists in the document.

isEqual

isEqual(other) returns boolean

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

Parameter

other

firebase.firestore.DocumentSnapshot

The DocumentSnapshot to compare against.

Value must not be null.

Returns

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

Abstract types

exists

inner

boolean

Property of the DocumentSnapshot that signals whether or not the data exists. True if the document exists.

id

inner

string

Property of the DocumentSnapshot that provides the document's ID.

metadata

inner

non-null firebase.firestore.SnapshotMetadata

Metadata about the DocumentSnapshot, including information about its source and local modifications.

ref

inner

non-null firebase.firestore.DocumentReference

The DocumentReference for the document included in the DocumentSnapshot.