Stay organized with collections
Save and categorize content based on your preferences.
Options that configure how data is retrieved from a DocumentSnapshot (for example the desired behavior for server timestamps that have not yet been set to their final value).
If set, controls the return value for server timestamps that have not yet been set to their final value.By specifying 'estimate', pending server timestamps return an estimate based on the local clock. This estimate will differ from the final value and cause these values to change once the server result becomes available.By specifying 'previous', pending timestamps will be ignored and return their previous value instead.If omitted or set to 'none', null will be returned by default until the server value becomes available.
SnapshotOptions.serverTimestamps
If set, controls the return value for server timestamps that have not yet been set to their final value.
By specifying 'estimate', pending server timestamps return an estimate based on the local clock. This estimate will differ from the final value and cause these values to change once the server result becomes available.
By specifying 'previous', pending timestamps will be ignored and return their previous value instead.
If omitted or set to 'none', null will be returned by default until the server value becomes available.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-07-22 UTC."],[],[],null,["# SnapshotOptions interface\n\nOptions that configure how data is retrieved from a `DocumentSnapshot` (for example the desired behavior for server timestamps that have not yet been set to their final value).\n\n**Signature:** \n\n export declare interface SnapshotOptions \n\nProperties\n----------\n\n| Property | Type | Description |\n|-------------------------------------------------------------------------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [serverTimestamps](./firestore_.snapshotoptions.md#snapshotoptionsservertimestamps) | 'estimate' \\| 'previous' \\| 'none' | If set, controls the return value for server timestamps that have not yet been set to their final value.By specifying 'estimate', pending server timestamps return an estimate based on the local clock. This estimate will differ from the final value and cause these values to change once the server result becomes available.By specifying 'previous', pending timestamps will be ignored and return their previous value instead.If omitted or set to 'none', `null` will be returned by default until the server value becomes available. |\n\nSnapshotOptions.serverTimestamps\n--------------------------------\n\nIf set, controls the return value for server timestamps that have not yet been set to their final value.\n\nBy specifying 'estimate', pending server timestamps return an estimate based on the local clock. This estimate will differ from the final value and cause these values to change once the server result becomes available.\n\nBy specifying 'previous', pending timestamps will be ignored and return their previous value instead.\n\nIf omitted or set to 'none', `null` will be returned by default until the server value becomes available.\n\n**Signature:** \n\n readonly serverTimestamps?: 'estimate' | 'previous' | 'none';"]]
