Permalink
Browse files

document synonyms

  • Loading branch information...
1 parent cfa8eb5 commit 599c9e4944417f50b38571a46f8a20264a2566e3 @dominictarr committed Oct 30, 2012
Showing with 3 additions and 0 deletions.
  1. +3 −0 readme.markdown
View
3 readme.markdown
@@ -31,13 +31,16 @@ var kv = require('kv')('kv:') //this will be prefixed to keys when saving in loc
stream.pipe(kv.put(key, opts))
```
+`kv.createWriteStream` is a synonym for `kv.put`
+
### get a stream
`opts` is optional. see [fs.createReadStream](http://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options)
``` js
kv.get(key, opts).pipe(stream)
```
+`kv.createReadStream` is a synonym for `kv.get`
### del a stream

0 comments on commit 599c9e4

Please sign in to comment.