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

Method Alerts Return Type Description
get(entry) Alpha Promise<any>
put(entry, value) Alpha Promise<void>
removeEntries() Alpha Promise<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

Parameter Type Description
entry IEntry

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

Parameter Type Description
entry IEntry
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(): Promise<void>;

Returns

Return type: Promise<void>