flat-cache

constructor

constructor(options?: FlatCacheOptions);

property cache

readonly cache: CacheableMemory;

• The cache object cache {CacheableMemory}

property cacheDir

cacheDir: string;

• The cache directory cacheDir {String} '.cache'

property cacheDirPath

readonly cacheDirPath: string;

• Returns the path to the cache directory cacheDirPath

  Returns

  {String}

property cacheFilePath

readonly cacheFilePath: string;

• Returns the path to the file where the cache is persisted cacheFilePath

  Returns

  {String}

property cacheId

cacheId: string;

• The cache id cacheId {String} 'cache1'

property changesSinceLastSave

readonly changesSinceLastSave: boolean;

• The flag to indicate if there are changes since the last save changesSinceLastSave {Boolean} false

property items

readonly items: { key: string; value: any; expires?: number }[];

• Returns an array with all the items in the cache { key, value, ttl } items

  Returns

  {Array}

property persistInterval

persistInterval: number;

• The interval to persist the cache to disk. 0 means no timed persistence persistInterval {Number} 0

method all

all: () => Record<string, any>;

• Returns the entire persisted object all

  Returns

  {*}

method clear

clear: () => void;

• Clear the cache and save the state to disk clear

method delete

delete: (key: string) => void;

• Remove a given key from the cache delete

  Parameter key

  the key to remove from the object

method destroy

destroy: (includeCacheDirectory?: boolean) => void;

• Destroy the cache. This will remove the directory, file, and memory cache destroy

  Parameter includeCacheDir

  if true, the cache directory will be removed {undefined}

method get

get: <T>(key: string) => T;

• Return the value of the provided key get

  Parameter key

  the name of the key to retrieve

  Returns

  {*} at T the value from the key

method getKey

getKey: <T>(key: string) => T;

• (Legacy) Return the value of the provided key. This method will be deprecated in the future getKey

  Parameter key

  the name of the key to retrieve

  Returns

  {*} at T the value from the key

method keys

keys: () => string[];

• Returns an array with all the keys in the cache keys

  Returns

  {Array}

method load

load: (cacheId?: string, cacheDir?: string) => void;

• Load a cache identified by the given Id. If the element does not exists, then initialize an empty cache storage. If specified cacheDir will be used as the directory to persist the data to. If omitted then the cache module directory .cacheDir will be used instead

  load

  Parameter cacheId

  the id of the cache, would also be used as the name of the file cache

  Parameter cacheDir

  directory for the cache entry

method loadFile

loadFile: (pathToFile: string) => void;

• Load the cache from the provided file loadFile

  Parameter pathToFile

  the path to the file containing the info for the cache

method loadFileStream

loadFileStream: (
    pathToFile: string,
    onProgress: (progress: number, total: number) => void,
    onEnd: () => void,
    onError?: (error: Error) => void
) => void;

method removeCacheFile

removeCacheFile: () => boolean;

• Remove the file where the cache is persisted removeCacheFile {Boolean} true or false if the file was successfully deleted

method removeKey

removeKey: (key: string) => void;

• (Legacy) Remove a given key from the cache. This method will be deprecated in the future removeKey

  Parameter key

  the key to remove from the object

method save

save: (force?: boolean) => void;

• Save the state of the cache identified by the docId to disk as a JSON structure save

method set

set: (key: string, value: any, ttl?: number | string) => void;

• Sets a key to a given value set

  Parameter key

  the key to set

  Parameter value

  the value of the key. Could be any object that can be serialized with JSON.stringify

  Parameter ttl

  the time to live in milliseconds

method setKey

setKey: (key: string, value: any, ttl?: number | string) => void;

• (Legacy) set key method. This method will be deprecated in the future setKey

  Parameter key

  the key to set

  Parameter value

  the value of the key. Could be any object that can be serialized with JSON.stringify

method startAutoPersist

startAutoPersist: () => void;

• Start the auto persist interval startAutoPersist

method stopAutoPersist

stopAutoPersist: () => void;

• Stop the auto persist interval stopAutoPersist

property clearAll

static clearAll: (cacheDirectory?: string) => void;

property clearCacheById

static clearCacheById: (cacheId: string, cacheDirectory?: string) => void;

property create

static create: (options?: FlatCacheOptions) => FlatCache;

property createFromFile

static createFromFile: (
    filePath: string,
    options?: FlatCacheOptions
) => FlatCache;

member CLEAR

CLEAR = 'clear'

member DELETE

DELETE = 'delete'

member DESTROY

DESTROY = 'destroy'

member ERROR

ERROR = 'error'

member EXPIRED

EXPIRED = 'expired'

member LOAD

LOAD = 'load'

member SAVE

SAVE = 'save'