Skip to main content

INonPersistentCache Interface

Internal cache interface used within driver only

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/odsp-driver/legacy.

For more information about our API support guarantees, see here.

Signature

export interface INonPersistentCache

Properties

PropertyAlertsModifiersTypeDescription
fileUrlCacheBetareadonlyPromiseCache<string, IOdspResolvedUrl>Cache of resolved/resolving file URLs
sessionJoinCacheBetareadonlyPromiseCache<string, { entryTime: number; joinSessionResponse: ISocketStorageDiscovery; }>Cache of joined/joining session info
snapshotPrefetchResultCacheBetareadonlyPromiseCache<string, IPrefetchSnapshotContents>Used to store the snapshot fetch promise if the prefetch has been made using the prefetchLatestSnapshot api. This is then used later to look for the promise during the container load.

Property Details

fileUrlCache

Cache of resolved/resolving file URLs

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly fileUrlCache: PromiseCache<string, IOdspResolvedUrl>;

Type: PromiseCache<string, IOdspResolvedUrl>

sessionJoinCache

Cache of joined/joining session info

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly sessionJoinCache: PromiseCache<string, {
entryTime: number;
joinSessionResponse: ISocketStorageDiscovery;
}>;

Type: PromiseCache<string, { entryTime: number; joinSessionResponse: ISocketStorageDiscovery; }>

snapshotPrefetchResultCache

Used to store the snapshot fetch promise if the prefetch has been made using the prefetchLatestSnapshot api. This is then used later to look for the promise during the container load.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly snapshotPrefetchResultCache: PromiseCache<string, IPrefetchSnapshotContents>;

Type: PromiseCache<string, IPrefetchSnapshotContents>