UNPKG

voluptasmollitia

Version:
30 lines (17 loc) 1.31 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; [DocumentSnapshot](./firestore_.documentsnapshot.md) &gt; [get](./firestore_.documentsnapshot.get.md) ## DocumentSnapshot.get() method Retrieves the field specified by `fieldPath`<!-- -->. Returns `undefined` if the document or field doesn't exist. By default, a `FieldValue.serverTimestamp()` that has not yet been set to its final value will be returned as `null`<!-- -->. You can override this by passing an options object. <b>Signature:</b> ```typescript get(fieldPath: string | FieldPath, options?: SnapshotOptions): any; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | fieldPath | string \| [FieldPath](./firestore_.fieldpath.md) | The path (for example 'foo' or 'foo.bar') to a specific field. | | options | [SnapshotOptions](./firestore_.snapshotoptions.md) | An options object to configure how the field is retrieved from the snapshot (for example the desired behavior for server timestamps that have not yet been set to their final value). | <b>Returns:</b> any The data at the specified field location or undefined if no such field exists in the document.