Helper functions for managing result-set cache.
- Source
Methods
(static) buildKey(optsopt) → {string}
Build a cache key for the result set.
Parameters:
| Name | Type | Attributes | Default | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts | object | <optional> | {} | The options for building the cache key Properties
|
- Source
Returns:
- Returns the generated cache key
- Type:
- string
(async, static) clear(optsopt) → {Promise.<void>}
Clear cached result set items.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
opts | object | <optional> | {} | The options for clearing the cached result set |
- Source
Returns:
- Type:
- Promise.<void>
(async, static) get(optsopt) → {Promise.<*>}
Get a cached result set item.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
opts | object | <optional> | {} | The options for retrieving the cached result set |
- Source
Returns:
- Returns the cached result set item or false if not found
- Type:
- Promise.<*>
(async, static) remove(optsopt) → {Promise.<void>}
Remove a cached result set item.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
opts | object | <optional> | {} | The options for removing the cached result set |
- Source
Returns:
- Type:
- Promise.<void>
(async, static) set(optsopt) → {Promise.<void>}
Set a cached result set item.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
opts | object | <optional> | {} | The options for setting the cached result set |
- Source
Returns:
- Type:
- Promise.<void>