Constructor

FieldPath

new FieldPath(...var_args)

A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top-level field in the document), or a list of field names (referring to a nested field in the document).

Create a FieldPath by providing field names. If more than one field name is provided, the path will point to a nested field in a document.

Parameter

var_args

any type

A list of field names.

Value may be repeated.

Methods

documentId

static

documentId() returns firebase.firestore.FieldPath

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

Returns

non-null firebase.firestore.FieldPath 

isEqual

isEqual(other) returns boolean

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

Parameter

other

firebase.firestore.FieldPath

The FieldPath to compare against.

Value must not be null.

Returns

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