sys.cache
sys.cache
This package contains methods to handle app cache across all app instances. Cache is useful when fast performance is needed when reading app information. This should be carefully used since app heap memory can be affected when a lot of information is stored in cache.
put(mapName, key, value)
Puts a key-value pair into a specified cache map. Returns the previous value associated with the key, or null.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| mapName | string | yes | Name of the cache map |
| key | string | yes | The key |
| value | _ | yes | The value to be cached |
Returns
any - The previous value associated with the key, or null if there wasn’t any
get(mapName, key)
Gets a value from the specified cache map. Returns null if the key is not found.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| mapName | string | yes | Name of the cache map |
| key | string | yes | The key |
Returns
any - The value associated with the key, or null if the key is not found
remove(mapName, key)
Removes a key-value pair from the specified cache map. Returns the removed value, if any.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| mapName | string | yes | Name of the cache map |
| key | string | yes | The key |
Returns
any - The removed value, or null if there was no value associated with the key
clear(mapName)
Clears all entries from the specified cache map.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| mapName | string | no | Name of the cache map.If not provided all maps are cleared |
Returns
void
maps()
Returns a list of the existing cache maps names.
Returns
string[] - The map names
mapKeys(mapName)
Returns a list of keys of a specified map.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| mapName | string | no | Name of the cache map. If not provided an empty list is returned |
Returns
string[] - The map keys
sys.cache.data
This package contains methods to handle app cache optimized for handling application data.
clear(entityName)
Clears data cache for a given entity or all cache if no entity is provided.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| entityName | string | no | Name of the entity. If not provided, then all entities cache are cleared |
Returns
void
findAll(entityName, indexes, options)
Finds all cached data of an entity. Loads the entity records if not cached. If indexes are provided, then app data is indexed on load.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| entityName | string | yes | Name of the entity |
| indexes | string[] | no | Array of index names |
| options | object | no | These parameters are used to sort results. - sortBy: Indicates which field should be considered when sorting.- sortType: Options are “asc” or “desc.” |
Returns
sys.data.Record[] - Array of records
find(entityName, key, value, indexes, options)
Finds cached data of an entity given a field and value. Loads the entity if not cached. If indexes are provided, then app data is indexed on load.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| entityName | string | yes | Name of the entity |
| key | string | yes | The key |
| value | any | yes | The value |
| indexes | string[] | no | Array of index names |
| options | object | no | These parameters are used to sort results. - sortBy: Indicates which field should be considered when sorting.- sortType: Options are “asc” or “desc.” |
Returns
sys.data.Record[] - Array of records
findOne(entityName, key, value, indexes)
Finds the first cached record of an entity matching a field and value. If not cached, the entity will be loaded. If indexes are provided, then app data is indexed on load. Returns null if not found.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| entityName | string | yes | Name of the entity |
| key | string | yes | The key |
| value | any | yes | The value |
| indexes | string[] | no | Array of index names |
Returns
sys.data.Record - The first matching record, or null if not found
entities()
Returns a list of cached entities.
Returns
string[] - The cached entities keys
entityIndexes(entity)
Returns a list of the indexes of a specified entity.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| entity | string | no | Name of the entity. If not provided or entity not cached an empty list is returned |
Returns
string[] - The cached indexes
indexKeys(entity, index)
Returns a list of values of a specified index.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| entity | string | yes | Name of the entity |
| index | string | yes | Name of the index |
Returns
object[] - The index values