Skip to content

Commit 43f1fea

Browse files
author
jpodwys
committed
Update README.md
1 parent 91ab1bf commit 43f1fea

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,33 @@ Only for use with [superagent-cache](https://github.com/jpodwys/superagent-cache
154154

155155
# API
156156

157+
## .get(key, callback (err, response))
157158

159+
Retrieve a value by a given key.
158160

159-
# More Documentation Coming Soon
161+
* key: type: string
162+
* callback: type: function
163+
* err: type: object
164+
* response: type: string or object
165+
166+
## .set(key, value [, expiraiton, callback])
167+
168+
Set a value by a given key.
169+
170+
* key: type: string
171+
* callback: type: function
172+
* expiration: type: int, measure: seconds
173+
* callback: type: function
174+
175+
## .del(keys, callback (err, count))
176+
177+
Delete a key or an array of keys and their associated values.
178+
179+
* keys: type: string || array of strings
180+
* callback: type: function
181+
* err: type: object
182+
* count: type: int
183+
184+
## .flush()
185+
186+
Flush all keys and values from an instance of cache-service.

0 commit comments

Comments
 (0)