Mark DuckworthandGitHub
017073ed9b
* Support function links to function overloads. * Improve readability of headings for functions.
2.1 KiB
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 %}
FieldPath class
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.