Constructor
new cache() → {cache}
Creates or returns the singleton cache instance.
Returns:
the singleton cache instance.
- Type
- cache
Members
cacheErrors
Properties:
| Name | Type | Description |
|---|---|---|
cacheErrors |
object | the frozen stable package error codes for operational branching. |
cacheNamespace
Properties:
| Name | Type | Description |
|---|---|---|
cacheNamespace |
string | the 'prefix' used to group our keys in the cache Server. This property switches to a new namespace, to be used for all subsequent cache operations as the default. The namespace must already exist in the cache servers 'namespace' list, see addNamespace(). |
cacheNamespaces
Properties:
| Name | Type | Description |
|---|---|---|
cacheNamespaces |
array | returns an array containing all the namespaces defined in the cache server. The array contains objects with name, type (node or redis), enabled properties, and current statistics for each namespace. |
cacheReady
Properties:
| Name | Type | Description |
|---|---|---|
cacheReady |
boolean | whether the cache instance and configured Redis namespaces are ready. |
cacheTTL
Properties:
| Name | Type | Description |
|---|---|---|
cacheTTL |
number | the cache Time-To-Live property, in seconds. |
redisMinimumVersion
Properties:
| Name | Type | Description |
|---|---|---|
redisMinimumVersion |
string | the minimum supported Redis server version. |
redisPassword
Properties:
| Name | Type | Description |
|---|---|---|
redisPassword |
string | the Password to the Redis Server. |
redisPort
Properties:
| Name | Type | Description |
|---|---|---|
redisPort |
string | the PORT to the Redis Server. |
redisStatus
Properties:
| Name | Type | Description |
|---|---|---|
redisStatus |
object | the frozen stable Redis namespace status constants. |
redisURL
Properties:
| Name | Type | Description |
|---|---|---|
redisURL |
string | the URL to the Redis Server. |
redisUser
Properties:
| Name | Type | Description |
|---|---|---|
redisUser |
string | the User to the Redis Server. |