UNPKG

voluptasmollitia

Version:
33 lines (19 loc) 1.2 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [doc](./firestore_.doc_2.md) ## doc() function Gets a `DocumentReference` instance that refers to a document within `reference` at the specified relative path. <b>Signature:</b> ```typescript export declare function doc(reference: DocumentReference<unknown>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | reference | [DocumentReference](./firestore_.documentreference.md)<!-- -->&lt;unknown&gt; | A reference to a Firestore document. | | path | string | A slash-separated path to a document. | | pathSegments | string\[\] | Additional path segments that will be applied relative to the first argument. | <b>Returns:</b> [DocumentReference](./firestore_.documentreference.md)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md)<!-- -->&gt; The `DocumentReference` instance. ## Exceptions If the final path has an odd number of segments and does not point to a document.