FieldPath class
Stay organized with collections
Save and categorize content based on your preferences.
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.
Signature:
export declare class FieldPath
Constructors
| Constructor |
Modifiers |
Description |
| (constructor)(fieldNames) |
|
Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document. |
Methods
| Method |
Modifiers |
Description |
| isEqual(other) |
|
Returns true if this FieldPath is equal to the provided one. |
FieldPath.(constructor)
Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.
Signature:
constructor(...fieldNames: string[]);
Parameters
| Parameter |
Type |
Description |
| fieldNames |
string[] |
A list of field names. |
FieldPath.isEqual()
Returns true if this FieldPath is equal to the provided one.
Signature:
isEqual(other: FieldPath): boolean;
Parameters
| Parameter |
Type |
Description |
| other |
FieldPath |
The FieldPath to compare against. |
Returns:
boolean
true if this FieldPath is equal to the provided one.
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-01-19 UTC.
[null,null,["Last updated 2024-01-19 UTC."],[],[],null,["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).\n\nCreate 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.\n\n**Signature:** \n\n export declare class FieldPath \n\nConstructors\n\nMethods\n\nFieldPath.(constructor)\n\nCreates a `FieldPath` from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.\n\n**Signature:** \n\n constructor(...fieldNames: string[]);\n\nParameters\n\nFieldPath.isEqual()\n\nReturns true if this `FieldPath` is equal to the provided one.\n\n**Signature:** \n\n isEqual(other: FieldPath): boolean;\n\nParameters\n\n**Returns:**\n\nboolean\n\ntrue if this `FieldPath` is equal to the provided one."]]
