admin.firestore.FieldPath

class   static

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.

Method

documentId

static

documentId() returns admin.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 admin.firestore.FieldPath