docs-devsite/firestore_lite.fieldpath.md
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
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.
<b>Signature:</b>
export declare class FieldPath
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(fieldNames) | Creates a <code>FieldPath</code> from the provided field names. If more than one field name is provided, the path will point to a nested field in a document. |
| Method | Modifiers | Description |
|---|---|---|
| isEqual(other) | Returns true if this <code>FieldPath</code> is equal to the provided one. |
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.
<b>Signature:</b>
constructor(...fieldNames: string[]);
| Parameter | Type | Description |
|---|---|---|
| fieldNames | string[] | A list of field names. |
Returns true if this FieldPath is equal to the provided one.
<b>Signature:</b>
isEqual(other: FieldPath): boolean;
| Parameter | Type | Description |
|---|---|---|
| other | FieldPath | The <code>FieldPath</code> to compare against. |
<b>Returns:</b>
boolean
true if this FieldPath is equal to the provided one.