All files / core/src/types ICache.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import type { IImageLoadObject, IVolumeLoadObject } from './ILoadObject';
 
interface ICache {
  /** Set the maximum cache size  */
  setMaxCacheSize: (maxCacheSize: number) => void;
  /** Get the maximum cache size  */
  getMaxCacheSize: () => number;
  /** Get the current cache size  */
  getCacheSize: () => number;
  /** Stores the imageLoad Object inside the cache */
  putImageLoadObject: (
    imageId: string,
    imageLoadObject: IImageLoadObject,
    updateCache?: boolean
  ) => Promise<void>;
  /** Retrieves the imageLoad Object from the cache */
  getImageLoadObject: (imageId: string) => IImageLoadObject | void;
  /** Stores the volumeLoad Object inside the cache */
  putVolumeLoadObject: (
    volumeId: string,
    volumeLoadObject: IVolumeLoadObject
  ) => Promise<void>;
  /** Retrieves the volumeLoad Object from the cache */
  getVolumeLoadObject: (volumeId: string) => IVolumeLoadObject | void;
  /** Purge cache both image and volume */
  purgeCache: () => void;
}
 
export type { ICache as default };