Class FieldPath (4.14.2)
Stay organized with collections
Save and categorize content based on your preferences.
A dot-separated path for navigating sub-objects (e.g. nested maps) within a document.
Package
@google-cloud/firestore!
Constructors
(constructor)(segments)
constructor(...segments: string[]);
Constructs a Firestore Field Path.
| Name | Description |
| segments |
string[]
Sequence of field names that form this path.
|
Methods
documentId()
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.
isEqual(other)
isEqual(other: FieldPath): boolean;
Returns true if this FieldPath is equal to the provided value.
| Name | Description |
| other |
FieldPath
The value to compare against. {boolean} true if this FieldPath is equal to the provided value.
|
Returns
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-05-08 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
