@absolunet/ioc2.1.0

View on GitHub

CacheManager

Cache manager that uses the configuration to properly handle caching operation through drivers.

Extends

Members

(static) dependencies :Array.<string>

Source:
Class dependencies: ['app', 'config'].

Methods

resolve(storeopt)

Source:
Resolve cache store by name.
Parameters:
Name Type Attributes Description
store string <optional>
 The store name.
Throws:
Indicates that the driver could not be resolved.
Type
TypeError
Returns:
The Driver instance.
Type
cache.services.CacheManager.drivers.Driver

resolveDefault()

Source:
Resolve default store.
Returns:
The default driver instance.
Type
cache.services.CacheManager.drivers.Driver

build(driver, configopt)

Source:
Build store by driver name and by configuration.
Parameters:
Name Type Attributes Default Description
driver string The driver name.
config object.<string, *> <optional>
 {} The driver configuration.
Returns:
The driver instance.
Type
cache.services.CacheManager.drivers.Driver

getForward()

Source:
Get default cache store driver for forward calls.
Returns:
The default driver instance.
Type
cache.services.CacheManager.drivers.Driver

driver(nameopt, parametersopt)

Source:
Overrides:
Get loader driver by name.
Parameters:
Name Type Attributes Default Description
name string <optional>
 "default" The driver name.
parameters object <optional>
 {} The additional parameters to inject into the driver instance.
Returns:
The resolved driver instance.
Type
object

bootDriver(driver, name)

Source:
Overrides:
Boot newly created driver.
Parameters:
Name Type Description
driver * The driver instance.
name string The driver name.
Returns:
The driver instance.
Type
*

addDriver(name, driver)

Source:
Overrides:
Add a driver and bind it with the given name.
Parameters:
Name Type Description
name string The driver name.
driver function The driver class or factory.

setDefaultDriver(name)

Source:
Overrides:
Set given driver name as the default driver.
Parameters:
Name Type Description
name string The driver name.

setDriverAlias(name, alias)

Source:
Overrides:
Give driver an alias name.
Parameters:
Name Type Description
name string The driver name.
alias string The driver alias.

hasDriver(name)

Source:
Overrides:
Check if driver exists.
Parameters:
Name Type Description
name string The driver name.
Returns:
Indicates that the driver exists.
Type
boolean

isDriverAlias(name)

Source:
Overrides:
Check if given driver name is an alias.
Parameters:
Name Type Description
name string The driver alias name.
Returns:
Indicates that the alias exists.
Type
boolean