IDocumentStorageServicePolicies Interface
Policies describing attributes or characteristics of the driver's storage service, to direct how other components interact with the driver
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IDocumentStorageServicePolicies
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| caching | Beta | optional, readonly | LoaderCachingPolicy | Should the Loader implement any sort of pre-fetching or caching mechanism? |
| maximumCacheDurationMs | Beta | optional, readonly | FiveDaysMs | IMPORTANT: This policy MUST be set to 5 days and PROPERLY ENFORCED for drivers that are used in applications where Garbage Collection is enabled. Otherwise data loss may occur. This policy pertains to requests for the latest snapshot from the service. If set, it means that the driver guarantees not to use a cached value that was fetched more than 5 days ago. If undefined, the driver makes no guarantees about the age of snapshots used for loading. |
Property Details
caching
Should the Loader implement any sort of pre-fetching or caching mechanism?
For more information about our API support guarantees, see here.
Signature
readonly caching?: LoaderCachingPolicy;
Type: LoaderCachingPolicy
maximumCacheDurationMs
IMPORTANT: This policy MUST be set to 5 days and PROPERLY ENFORCED for drivers that are used in applications where Garbage Collection is enabled. Otherwise data loss may occur.
This policy pertains to requests for the latest snapshot from the service. If set, it means that the driver guarantees not to use a cached value that was fetched more than 5 days ago. If undefined, the driver makes no guarantees about the age of snapshots used for loading.
For more information about our API support guarantees, see here.
Signature
readonly maximumCacheDurationMs?: FiveDaysMs;
Type: FiveDaysMs