FluidFramework/api-report/driver-web-cache.api.md

1.1 KiB

API Report File for "@fluidframework/driver-web-cache"

Do not edit this file. It is a report generated by API Extractor.


import { ICacheEntry } from '@fluidframework/odsp-driver-definitions';
import { IFileEntry } from '@fluidframework/odsp-driver-definitions';
import { IPersistedCache } from '@fluidframework/odsp-driver-definitions';
import { ITelemetryBaseLogger } from '@fluidframework/common-definitions';

// @public (undocumented)
export function deleteFluidCacheIndexDbInstance(): Promise<void>;

// @public
export class FluidCache implements IPersistedCache {
    constructor(config: FluidCacheConfig);
    // (undocumented)
    get(cacheEntry: ICacheEntry): Promise<any>;
    // (undocumented)
    put(entry: ICacheEntry, value: any): Promise<void>;
    // (undocumented)
    removeEntries(file: IFileEntry): Promise<void>;
}

// @public (undocumented)
export interface FluidCacheConfig {
    logger?: ITelemetryBaseLogger;
    maxCacheItemAge: number;
    partitionKey: string | null;
}


// (No @packageDocumentation comment for this package)