Expand all

ve.init.mw.TemplateDataCache

Extends

Constructor

new ve.init.mw.TemplateDataCache([api]) #

Get TemplateData.

Parameters:

Name Type Attributes Description
api mw.Api optional
Source:
Get TemplateData.

Properties

getRequestPromise #

Get an API request promise to deal with a list of titles

Overrides:
Source:
Get an API request promise to deal with a list of titles

Methods

get(title) → {jQuery.Promise} #

Look up data about a title. If the data about this title is already in the cache, this returns an already-resolved promise. Otherwise, it returns a pending promise and schedules an request to retrieve the data.

Parameters:

Name Type Description
title string

Returns:

Promise that will be resolved with the data once it's available

Type
jQuery.Promise
Inherited from:
Source:
Look up data about a title.

getCached(name) → {Object|undefined} #

Look up data about a page in the cache. If the data about this page is already in the cache, this returns that data. Otherwise, it returns undefined.

Parameters:

Name Type Description
name string

Normalized page title

Returns:

Cache data for this name.

Type
Object | undefined
Inherited from:
Source:
Look up data about a page in the cache.

init() #

Initialize the caches.

Can be called again to reset the cache, e.g. by tests

Inherited from:
Source:
Initialize the caches.

processQueue()private #

Perform any scheduled API requests.

Fires:

Inherited from:
Source:
Perform any scheduled API requests.

set(entries) #

Add entries to the cache. Does not overwrite already-set entries.

Parameters:

Name Type Description
entries Object

Object keyed by page title, with the values being data objects

Fires:

Inherited from:
Source:
Add entries to the cache.

processPage()static #

Source:

Events

add(entries) #

Fired when a new entry is added to the cache.

Parameters:

Name Type Description
entries Object

Cache entries that were added. Object mapping names to data objects.
Inherited from:
Source:
Fired when a new entry is added to the cache.