Constructor

FieldPath

new FieldPath(segments)

Constructs a Firestore Field Path.

Parameter

segments

(repeatable string or Array of string)

Sequence of field names that form this path.

Methods

documentId

static

documentId() returns FieldPath

A special FieldPath value to refer to the ID of a document. It can be used in queries to sort or filter by the document ID.

Returns

FieldPath 

isEqual

isEqual(other) returns boolean

Returns true if this FieldPath is equal to the provided value.

Parameter

other

any type

The value to compare against.

Returns

boolean 

true if this FieldPath is equal to the provided value.