UNPKG

voluptasmollitia

Version:
29 lines (17 loc) 1.22 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [lite](./firestore_lite.md) &gt; [FieldPath](./firestore_lite.fieldpath.md) ## 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. <b>Signature:</b> ```typescript export declare class FieldPath ``` ## Constructors | Constructor | Modifiers | Description | | --- | --- | --- | | [(constructor)(fieldNames)](./firestore_lite.fieldpath._constructor_.md) | | 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)](./firestore_lite.fieldpath.isequal.md) | | Returns true if this <code>FieldPath</code> is equal to the provided one. |