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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-01-19 UTC."],[],[],null,["# FieldPath class\n\nA `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------------\n\n| Constructor | Modifiers | Description |\n|-----------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| [(constructor)(fieldNames)](./firestore_.fieldpath.md#fieldpathconstructor) | | 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. |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|--------------------------------------------------------------|-----------|----------------------------------------------------------------|\n| [isEqual(other)](./firestore_.fieldpath.md#fieldpathisequal) | | Returns true if this `FieldPath` is equal to the provided one. |\n\nFieldPath.(constructor)\n-----------------------\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\n#### Parameters\n\n| Parameter | Type | Description |\n|------------|------------|------------------------|\n| fieldNames | string\\[\\] | A list of field names. |\n\nFieldPath.isEqual()\n-------------------\n\nReturns true if this `FieldPath` is equal to the provided one.\n\n**Signature:** \n\n isEqual(other: FieldPath): boolean;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|--------------------------------------------------------|-------------------------------------|\n| other | [FieldPath](./firestore_.fieldpath.md#fieldpath_class) | The `FieldPath` to compare against. |\n\n**Returns:**\n\nboolean\n\ntrue if this `FieldPath` is equal to the provided one."]]
