Skip to main content

IPersistedFileCache Interface

Similar to IPersistedCache, but exposes cache interface for single file

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 IPersistedFileCache

Methods​

MethodAlertsReturn TypeDescription
get(entry)BetaPromise<any>
put(entry, value)BetaPromise<void>
removeEntries()BetaPromise<void>

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(entry: IEntry): Promise<any>;

Parameters​

ParameterTypeDescription
entryIEntry

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: IEntry, value: any): Promise<void>;

Parameters​

ParameterTypeDescription
entryIEntry
valueany

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

Returns​

Return type: Promise<void>