module:store/Cache

Caches loaded entries and keeps track of which entries that need to be updated (refreshed). The cache also provides a listener functionality that allows you to be notified of when entries are updated.

Constructor

new (require("store/Cache"))()

Source:

Cache.js, line 9

Methods

addCacheUpdateListener(listener)

Source:

Cache.js, line 192

Parameters:

Name	Type	Description
`listener`	function

addPromise(loadID, loadPromise)

Source:

Cache.js, line 161

Store the promise for loading something.

Parameters:

Name	Type	Description
`loadID`	String
`loadPromise`	Promise

allNeedRefresh()

Source:

Cache.js, line 229

Marks all entries as in need of refresh and consequently messages all listeners with the allEntriesNeedRefresh topic.

cache(entry, silentlyopt)

Source:

Cache.js, line 46

Add or update the entry to the cache. All listeners will be notified unless silently is specified.

Parameters:

Name	Type	Attributes	Description
`entry`	Entry
`silently`	Boolean	<optional>	listeners will be notified unless true is specified.

cacheAll(entryArr, silentlyopt)

Source:

Cache.js, line 116

See:

Cache#cache

A convenience method for caching multiple entries.

Parameters:

Name	Type	Attributes	Description
`entryArr`	Array.<Entry>
`silently`	Boolean	<optional>

clear()

Source:

Cache.js, line 242

Clears the cache from all cached entries. Warning: all references to entries needs to be discarded as they will not be kept in sync with changes.

get(entryURI) → {Entry|undefined}

Source:

Cache.js, line 128

Retrieve the entry from it's URI.

Parameters:

Name	Type	Description
`entryURI`	String

Returns:

Type: Entry | undefined

getByResourceURI(uri) → {Set.<Entry>}

Source:

Cache.js, line 141

Retrieve all entries that have the specified uri as resource. Note that since several entries (e.g. links) may have the same uri as resource this method returns an array. However, in many situations there will be zero or one entry per uri.

Parameters:

Name	Type	Description
`uri`	String

Returns:

always returns a set, may be empty though.

Type: Set.<Entry>

getPromise(loadID) → {Promise|undefined}

Source:

Cache.js, line 151

Retrieve a load promise.

Parameters:

Name	Type	Description
`loadID`	String

Returns:

Type: Promise | undefined

messageListeners(topic, affectedEntryopt)

Source:

Cache.js, line 219

Agreed topics are: allEntriesNeedRefresh - all entries are now in need of refresh, typically happens after a change of user(sign in) needRefresh - the specified entry need to be refreshed. refreshed - the specified entry have been refreshed.

Parameters:

Name	Type	Attributes	Description
`topic`	String
`affectedEntry`	Entry	<optional>

needRefresh(entry) → {boolean}

Source:

Cache.js, line 180

Tells whether the entry is in need of a refresh from the repository.

Parameters:

Name	Type	Description
`entry`	Entry

Returns:

Type: boolean

removeCacheUpdateListener(listener)

Source:

Cache.js, line 203

Parameters:

Name	Type	Description
`listener`	function

removePromise(loadID)

Source:

Cache.js, line 170

Remove the promise responsible for loading something.

Parameters:

Name	Type	Description
`loadID`	String

setRefreshNeeded(entry, silentlyopt)

Source:

Cache.js, line 97

Marks an entry as in need of refresh from the store. All listeners are notified of the entry now being in need of refreshing unless silently is set to true.

Parameters:

Name	Type	Attributes	Description
`entry`	Entry
`silently`	Boolean	<optional>

unCache(entry)

Source:

Cache.js, line 74

Removes a single entry from the cache.

Parameters:

Name	Type	Description
`entry`	Entry	the entry to remove.