pouchdb-list

4.2.0 • Public • Published

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.

API

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.

List.list(listPath[, options[, callback]])

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

listPath: a url of the form "designDocName/listFuncName/viewName"

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.

Source

PouchDB Server and its sub-packages are distributed as a monorepo.

For a full list of packages, see the GitHub source.

License

The Apache 2 License. See the LICENSE file for more information.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 4.2.0
    1,121
    • latest

Version History

Package Sidebar

Install

npm i pouchdb-list

Weekly Downloads

1,235

Version

4.2.0

License

Apache-2.0

Unpacked Size

83.7 kB

Total Files

5

Last publish

Collaborators

  • jan
  • daleharvey
  • garethbowen
  • garrensmith
  • nolanlawson
  • commandoline
  • gr2m