Object -
cache
:
AbstractCache
The cache:AbstractCache object is used for custom implementations of the Ballerina cache.
Any custom cache implementation should be object-wise similar.
Methods
Adds the given key value pair to the cache.
Returns the cached value associated with the provided key.
Discards a cached value from the cache.
Discards all the cached values from the cache.
Checks whether the given key has an associated cache value.
Returns all keys from the cache.
Returns the current size of the cache.
Returns the capacity of the cache.
Adds the given key value pair to the cache. If the cache previously contained a value associated with the key, the old value is replaced by the new value.
Parameters
- key string
-
Key of the value to be cached
- value any
-
Value to be cached
- maxAgeInSeconds int (default -1)
-
The time in seconds during which the cache entry is valid. '-1' means, the entry is valid forever
-
Return Type
(Error?) ()if successfully added to the cache orErrorif any error occurred while inserting the entry to the cache
Returns the cached value associated with the provided key.
Parameters
- key string
-
The key used to retrieve the cached value
-
Return Type
(any | Error) The cached value associated with the given key or an
Errorif the provided cache key is not available or if any error occurred while retrieving from the cache
Discards a cached value from the cache.
Parameters
- key string
-
Key of the cache entry which needs to be discarded
-
Return Type
(Error?) ()if successfully discarded or anErrorif the provided cache key is not available or if any error occurred while discarding from the cache
Discards all the cached values from the cache.
-
Return Type
(Error?) ()if successfully discarded all or anErrorif any error occurred while discarding all from the cache
hasKey
(string key)
returns booleanChecks whether the given key has an associated cache value.
Parameters
- key string
-
The key to be checked
-
Return Type
(boolean) trueif an associated cache value is available for the provided key orfalseif there is not a cache value associated with the provided key
keys
()
returns string[]Returns all keys from the cache.
-
Return Type
(string[]) Array of all the keys from the cache
size
()
returns intReturns the current size of the cache.
-
Return Type
(int) The size of the cache
capacity
()
returns intReturns the capacity of the cache.
-
Return Type
(int) The capacity of the cache