Class ArtifactCache

Cache to store model related data, implemented with the Cache API.

Implements

ArtifactCacheTemplate

Index

Constructors

Methods

addToCache deleteInCache fetchWithCache hasAllKeys responseTostoretype

Constructors

constructor

new ArtifactCache(scope: string): ArtifactCache
Parameters
- scope: string
Returns ArtifactCache
- Defined in artifact_cache.ts:94

Methods

addToCache

addToCache(url: string, storetype?: string, signal?: AbortSignal): Promise<void>
Fetch data from url and add into cache. If already exists in cache, should return instantly.
Parameters
- url: string
  The url to the data to be cached. *
- Optionalstoretype: string
  Only applies to ArtifactIndexedDBCache. Since indexedDB stores the actual *
- Optionalsignal: AbortSignal
  An optional AbortSignal to abort data retrival. data rather than a request, we specify storagetype. There are two options:
  
  "json": IndexedDB stores fetch(url).json()
  
  "arraybuffer": IndexedDB stores fetch(url).arrayBuffer()
  
  Note: This is an async function.
Returns Promise<void>
Implementation of ArtifactCacheTemplate.addToCache
- Defined in artifact_cache.ts:131

deleteInCache

deleteInCache(url: string): Promise<void>
Delete the corresponding url object in cache
Parameters
- url: string
  the corresponding url object to be deleted
Returns Promise<void>
Implementation of ArtifactCacheTemplate.deleteInCache
- Defined in artifact_cache.ts:161

fetchWithCache

fetchWithCache(
    url: string,
    storetype?: string,
    signal?: AbortSignal,
): Promise<any>
fetch the corresponding url object in response or stored object format
Parameters
- url: string
  url
- Optionalstoretype: string
  the storage type for indexedDB
- Optionalsignal: AbortSignal
  an optional abort signal to abort fetching
Returns Promise<any>
response in json, arraybuffer or pure response format
Implementation of ArtifactCacheTemplate.fetchWithCache
- Defined in artifact_cache.ts:121

hasAllKeys

hasAllKeys(keys: string[]): Promise<boolean>
Determine if all keys exist in the cache
Parameters
- keys: string[]
  the url key list of the strings
Returns Promise<boolean>
boolean value indicate if all keys are in cache
Implementation of ArtifactCacheTemplate.hasAllKeys
- Defined in artifact_cache.ts:147

responseTostoretype

responseTostoretype(response: Response, storetype?: string): Promise<any>
Convert the Response object to the expected storetype instead
Parameters
- response: Response
- Optionalstoretype: string
Returns Promise<any>
- Defined in artifact_cache.ts:101