Adds documentations for adapters and main constructors (#4951)
* wip * Adds documentations for adapters, and constructors * nits * nit
This commit is contained in:
@@ -1,23 +1,29 @@
|
||||
/*eslint no-unused-vars: "off"*/
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface CacheAdapter
|
||||
*/
|
||||
export class CacheAdapter {
|
||||
/**
|
||||
* Get a value in the cache
|
||||
* @param key Cache key to get
|
||||
* @return Promise that will eventually resolve to the value in the cache.
|
||||
* @param {String} key Cache key to get
|
||||
* @return {Promise} that will eventually resolve to the value in the cache.
|
||||
*/
|
||||
get(key) {}
|
||||
|
||||
/**
|
||||
* Set a value in the cache
|
||||
* @param key Cache key to set
|
||||
* @param value Value to set the key
|
||||
* @param ttl Optional TTL
|
||||
* @param {String} key Cache key to set
|
||||
* @param {String} value Value to set the key
|
||||
* @param {String} ttl Optional TTL
|
||||
*/
|
||||
put(key, value, ttl) {}
|
||||
|
||||
/**
|
||||
* Remove a value from the cache.
|
||||
* @param key Cache key to remove
|
||||
* @param {String} key Cache key to remove
|
||||
*/
|
||||
del(key) {}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user