close
The Wayback Machine - https://web.archive.org/web/20190717124540/https://firebase.google.com/docs/reference/node/firebase.firestore.Settings
Products Use Cases Pricing Docs Support
Go to console
Overview Guides Reference Samples Libraries

Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.

Index

Properties

Properties

Optional cacheSizeBytes

cacheSizeBytes: number

An approximate cache size threshold for the on-disk data. If the cache grows beyond this size, Firestore will start removing data that hasn't been recently used. The size is not a guarantee that the cache will stay below that size, only that if the cache exceeds the given size, cleanup will be attempted.

The default value is 40 MB. The threshold must be set to at least 1 MB, and can be set to CACHE_SIZE_UNLIMITED to disable garbage collection.

Optional host

host: string

The hostname to connect to.

Optional ssl

ssl: boolean

Whether to use SSL when connecting.

Optional timestampsInSnapshots

timestampsInSnapshots: boolean
deprecated

This setting will be removed in a future release. You should update your code to expect Timestamp objects and stop using the timestampsInSnapshots setting.

Specifies whether to use Timestamp objects for timestamp fields in DocumentSnapshots. This is enabled by default and should not be disabled.

Previously, Firestore returned timestamp fields as Date but Date only supports millisecond precision, which leads to truncation and causes unexpected behavior when using a timestamp from a snapshot as a part of a subsequent query.

So now Firestore returns Timestamp values instead of Date, avoiding this kind of problem.

To opt into the old behavior of returning Date objects, you can temporarily set timestampsInSnapshots to false.