Class: Cache

Constructor

new Cache(app)

Constructor.

Parameters:

Name	Type	Description
`app`	App	App instance

Source: class/cache.js, line 6

Methods

_purgeItem(name) → {void}

Remove a specific cache namespace or all first-level namespaces.

Parameters:

Name	Type	Description
`name`	string	Namespace name or `*` for all

Source: class/cache.js, line 109

Returns:

Type:: void

(async) dispose() → {Promise.<void>}

Dispose internal reference.

Source: class/cache.js, line 149

Returns:

Type:: Promise.<void>

getRootDir() → {string}

Get root directory. It will be used to store all cache files, organized by namespace and TTL.

Source: class/cache.js, line 20

Returns:

Absolute cache root directory

Type:: string

load(name, ttlDuropt) → {Promise.<*>}

Load cached content when available and not expired.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Cache key in namespaced path format
`ttlDur`	number \| string	<optional>	0	TTL duration (milliseconds or parseable duration)

Source: class/cache.js, line 51

Returns:

Cached value, or undefined if missing/expired

Type:: Promise.<*>

prep(name, ttlDuropt) → {Object|undefined}

Prepare cache paths for a namespaced key and TTL.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Cache key in namespaced path format
`ttlDur`	number \| string	<optional>	0	TTL duration (milliseconds or parseable duration)

Source: class/cache.js, line 31

Returns:

Prepared paths or undefined when not cacheable

Type:: Object | undefined

purge(nameopt) → {void}

Purge cache by namespace or remove expired TTL directories.

Parameters:

Name	Type	Attributes	Description
`name`	string	<optional>	Optional namespace to remove directly

Source: class/cache.js, line 129

Returns:

Type:: void

save(name, item, ttlDuropt) → {Promise.<void>}

Save a value into cache for the given key and TTL directory.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Cache key in namespaced path format
`item`	*			Value to persist
`ttlDur`	number \| string	<optional>	0	TTL duration (milliseconds or parseable duration)

Source: class/cache.js, line 76

Returns:

Resolves when the value is written

Type:: Promise.<void>

sync(name, item, ttlDuropt) → {Promise.<*>}

Return cached content, and store the fallback value if cache is empty

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Cache key in namespaced path format
`item`	*			Fallback value to save when cache miss happens
`ttlDur`	number \| string	<optional>	0	TTL duration (milliseconds or parseable duration)

Source: class/cache.js, line 97

Returns:

Cached content

Type:: Promise.<*>