Skip to main content

FluidCache Class

A cache that can be used by the Fluid ODSP driver to cache data for faster performance. \

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

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

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

Signature

export declare class FluidCache implements IPersistedCache

Implements: IPersistedCache

Constructors

Constructor Alerts Description
(constructor)(config) Beta Constructs a new instance of the FluidCache class

Methods

Method Alerts Return Type Description
get(cacheEntry) Beta Promise<any>
put(entry, value) Beta Promise<void>
removeEntries(file) Beta Promise<void>

Constructor Details

(constructor)

Constructs a new instance of the FluidCache class

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
constructor(config: FluidCacheConfig);

Parameters

Parameter Type Description
config FluidCacheConfig

Method Details

get

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
get(cacheEntry: ICacheEntry): Promise<any>;

Parameters

Parameter Type Description
cacheEntry ICacheEntry

Returns

Return type: Promise<any>

put

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
put(entry: ICacheEntry, value: any): Promise<void>;

Parameters

Parameter Type Description
entry ICacheEntry
value any

Returns

Return type: Promise<void>

removeEntries

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
removeEntries(file: IFileEntry): Promise<void>;

Parameters

Parameter Type Description
file IFileEntry

Returns

Return type: Promise<void>