pouchdb/pouchdb-list

Name: pouchdb-list

Owner: PouchDB

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

Created: 2015-08-19 07:07:44.0

Updated: 2016-02-04 14:59:14.0

Pushed: 2017-07-17 16:43:13.0

Homepage: null

Size: 21

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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:

hDB List plug-in
================
-------------------+-----------------+
deJS package name: | `pouchdb-list`_ |
-------------------+-----------------+
owser object name: | ``window.List`` |
-------------------+-----------------+

t, make sure you understand how list functions work in CouchDB. A
 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

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

uns 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