FieldPath

FieldPath

A dot-separated path for navigating sub-objects (e.g. nested maps) within a document.

Constructor

new FieldPath(…segments)

Constructs a Firestore Field Path.

Parameters:
Name Type Attributes Description
segments string <repeatable>

Sequence of field names that form this path.
Example
```
let query = firestore.collection('col');
let fieldPath = new FieldPath('f.o.o', 'bar');

query.where(fieldPath, '==', 42).get().then(snapshot => {
  snapshot.forEach(document => {
    console.log(`Document contains {'f.o.o' : {'bar' : 42}}`);
  });
});
```

Methods

isEqual(other) → {boolean}

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

Parameters:
Name Type Description
other *

The value to compare against.
Returns:
Type Description
boolean

true if this FieldPath is equal to the provided value.

(static) documentId() → {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:
Type Description
FieldPath