Interface CollectionOptions

Hierarchy

  • CollectionOptions

Index

Properties

Properties

Optional expiry

Defines the expiration policy for the collection data. This policy sets the TTL and dictates the conditions under which the TTL is refreshed or remains static.

WARNING: By default, if not explicitly provided, collection items are set to expire if not updated within the last three months. It is important to set an appropriate expiry policy to prevent unintentional data loss due to auto-expiration.

Collections with the CollectionExpirationMode.Never expiration mode specified in the expiry policy will not expire.

Expiration is handled on a per collection item basis. For example, the expiration policy for a dictionary would dictate when to expire individual key-value entries.

Generated using TypeDoc