Class CacheManager

Manages cached model files, backed by a pluggable StorageBackend.

Defaults to OPFS (Origin Private File System).

Index

Constructors

Methods

clear delete deleteMany download getMetadata getNameFromURL getSize list open write writeMetadata

Constructors

constructor

new CacheManager(backends?: StorageBackend[]): CacheManager
Parameters
- backends: StorageBackend[] = ...
  Array of storage backends to use, in order of preference ; if first is available, use it, otherwise try the next one.
Returns CacheManager
- Defined in src/cache-manager.ts:88

Methods

clear

clear(): Promise<void>
Clear all files currently in cache

Returns Promise<void>
- Defined in src/cache-manager.ts:303

delete

delete(nameOrURL: string): Promise<void>
Delete a single file in cache
Parameters
- nameOrURL: string
  Can be either an URL or a name returned by getNameFromURL() or list()
Returns Promise<void>
- Defined in src/cache-manager.ts:312

deleteMany

deleteMany(predicate: (e: CacheEntry) => boolean): Promise<void>
Delete multiple files in cache.
Parameters
- predicate: (e: CacheEntry) => boolean
  A predicate like array.filter(item => boolean)
Returns Promise<void>
- Defined in src/cache-manager.ts:324

download

download(url: string, options?: DownloadOptions): Promise<void>
Parameters
- url: string
- options: DownloadOptions = {}
Returns Promise<void>
- Defined in src/cache-manager.ts:124

getMetadata

getMetadata(name: string): Promise<null | CacheEntryMetadata>
Get metadata of a cached file
Parameters
- name: string
Returns Promise<null | CacheEntryMetadata>
- Defined in src/cache-manager.ts:244

getNameFromURL

getNameFromURL(url: string): Promise<string>
Convert a given URL into a storage key.

Format: ${hashSHA1(fullURL)}_${fileName}
Parameters
- url: string
Returns Promise<string>
- Defined in src/cache-manager.ts:103

getSize

getSize(name: string): Promise<number>
Get the size of a file in stored cache

NOTE: in case the download is stopped mid-way (i.e. user close browser tab), the file maybe corrupted, size maybe different from metadata.originalSize
Parameters
- name: string
  The file name returned by getNameFromURL() or list()
Returns Promise<number>
number of bytes, or -1 if file does not exist
- Defined in src/cache-manager.ts:236

list

list(): Promise<CacheEntry[]>
List all files currently in cache

Returns Promise<CacheEntry[]>
- Defined in src/cache-manager.ts:269

open

open(nameOrURL: string): Promise<null | Blob>
Open a file in cache for reading
Parameters
- nameOrURL: string
  The file name returned by getNameFromURL() or list(), or the original URL of the remote file
Returns Promise<null | Blob>
Blob, or null if file does not exist
- Defined in src/cache-manager.ts:218

write

write(
    name: string,
    stream: ReadableStream<any>,
    metadata: CacheEntryMetadata,
): Promise<void>
Parameters
- name: string
  The file name returned by getNameFromURL() or list()
- stream: ReadableStream<any>
- metadata: CacheEntryMetadata
Returns Promise<void>
Deprecated
Use download() instead

Write a new file to cache. This will overwrite existing file.
- Defined in src/cache-manager.ts:114

writeMetadata

writeMetadata(name: string, metadata: CacheEntryMetadata): Promise<void>
Write the metadata of the file to disk.
Parameters
- name: string
- metadata: CacheEntryMetadata
Returns Promise<void>
- Defined in src/cache-manager.ts:337