couchdb-iterator
Advanced tools
Comparing version 1.0.0 to 1.0.1
{ | ||
"name": "couchdb-iterator", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "A fast and easy to ease CouchDB iterator for views and all documents", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -29,4 +29,4 @@ # couchdb-iterator | ||
Calls `iterator` for all `rows` of the database referenced by `couchdbAddr`. | ||
If `view` is supplied, iterates only over the view's rows. | ||
Calls `iterator` for all rows of the database referenced by `couchdbAddr`. | ||
If a `view` is supplied, iterates only over that view's rows. | ||
@@ -36,2 +36,4 @@ This library aims to be fast, therefore iteration happens concurrently. The iterator function can be async but beware that order | ||
Examples: | ||
```js | ||
@@ -65,4 +67,3 @@ const couchdbIterator = require('couchdb-iterator'); | ||
The `couchdbAddr` argument must be connection string with protocol, host, port and database path (e.g.: http://localhost:5984/my-db') or a [nano](https://www.npmjs.com/package/nano) instance. | ||
The `view` argument is a string in the form of `designdoc/view` (e.g.: app/byUser); if omitted, all rows from the database will iterated. | ||
The `couchdbAddr` argument must be connection string with protocol, host, port and database path (e.g.: http://localhost:5984/my-db) or a [nano](https://www.npmjs.com/package/nano) instance. The `view` argument is a string in the form of `designdoc/view` (e.g.: app/byUser). | ||
@@ -69,0 +70,0 @@ Available options: |
85
20280