cache-service - npm Package Compare versions

Comparing version 0.1.3 to 0.1.4

package.json

 {
   "name": "cache-service",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "A tiered caching solution for node.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -157,4 +157,31 @@ # cache-service
 
+## .get(key, callback (err, response))
 
+Retrieve a value by a given key.
 
-# More Documentation Coming Soon
+* key: type: string
+* callback: type: function
+* err: type: object
+* response: type: string or object
+
+## .set(key, value [, expiraiton, callback])
+
+Set a value by a given key.
+
+* key: type: string
+* callback: type: function
+* expiration: type: int, measure: seconds
+* callback: type: function
+
+## .del(keys, callback (err, count))
+
+Delete a key or an array of keys and their associated values.
+
+* keys: type: string || array of strings
+* callback: type: function
+* err: type: object
+* count: type: int
+
+## .flush()
+
+Flush all keys and values from an instance of cache-service.

No alert changes

Improved metrics

Total package byte prevSize

26889

increased by2.35%

Number of lines in readme file

187

increased by16.88%

No dependency changes