pouchdb / pouchdb-list

A PouchDB plug-in that allows you to re-use your CouchDB list functions on the client side.

pouchdb-list

A PouchDB plug-in that allows you to re-use your CouchDB list functions on the client side. A browser version is available.

TODO: integrate, update & make nice:

.. _pouchdb-list-plug-in:

PouchDB List plug-in
====================
+----------------------+-----------------+
| NodeJS package name: | `pouchdb-list`_ |
+----------------------+-----------------+
| Browser object name: | ``window.List`` |
+----------------------+-----------------+

First, make sure you understand how list functions work in CouchDB. A
good start is `the CouchDB guide entry on lists`_.

.. _pouchdb-list: https://www.npmjs.org/package/pouchdb-list
.. _the CouchDB guide entry on lists: http://guide.couchdb.org/draft/transforming.html

.. js:function:: List.list(listPath[, options[, callback]])

   Runs a list function on a view. Both are specified via the
   ``listPath`` parameter.

   :param string listPath: a url of the form
       ``"designDocName/listFuncName/viewName"``
   :param object options: this object is supplemented with defaults
       until a complete `CouchDB request object`_ has been formed, which
       is then passed into the list function.
   :returns: When succesful, the list function's result in the form of a
       `CouchDB response object`_. Otherwise, an error object with one
       of the following statuses: 400, 404, 406 or 500.

.. _CouchDB request object: http://docs.couchdb.org/en/latest/json-structure.html#request-object
.. _CouchDB response object: http://docs.couchdb.org/en/latest/json-structure.html#response-object

pouchdb-list's Issues

Get test coverage up to 100%, even without external modules

Test coverage isn't completely at 100% (just run npm test). The code paths were previously probably covered by other packages (I suspect pouchdb-rewrite), but it's best if some dedicated tests were written. Running the test suites of other modules alongside own tests probably adds too much complexity to be worth it in this case.

include_docs seems not work

using a list function with include_docs=true will return the document in
row.doc after row=getRow()
Which does not work in this plugin.
It also not set a row.value

Fix documentation

rst -> md & expand

this still works?

witch version of pouch work this?
i got an error:

Uncaught (in promise) TypeError: db.getUrl is not a function

Document CouchDB required for testing

Maybe document in pouchdb-plugin-helper and reference it from each of the modules' README?