# pouchdb-list

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

Latest version **4.2.0** (published 2019-09-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install pouchdb-list
pnpm add pouchdb-list
yarn add pouchdb-list
bun add pouchdb-list
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.0 |
| Published | 2019-09-25 |
| First published | 2014-06-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 81.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 979 |
| Author | Marten de Vries |
| Maintainers | commandoline, daleharvey, garrensmith, gr2m, nolanlawson |
| Keywords | pouch, pouchdb, couch, couchdb, list, design |

## Links

- npm: https://www.npmjs.com/package/pouchdb-list
- Repository: https://github.com/pouchdb/pouchdb-server
- Homepage: https://github.com/pouchdb/pouchdb-server#readme
- Issues: https://github.com/pouchdb/pouchdb-server/issues
- npm.io page: https://npm.io/package/pouchdb-list

## Dependencies (7)

- [extend](https://npm.io/package/extend.md) ^3.0.0
- [couchdb-render](https://npm.io/package/couchdb-render.md) 4.2.0
- [promise-nodify](https://npm.io/package/promise-nodify.md) ^1.0.2
- [couchdb-objects](https://npm.io/package/couchdb-objects.md) 4.2.0
- [pouchdb-promise](https://npm.io/package/pouchdb-promise.md) ^6.4.1
- [pouchdb-plugin-error](https://npm.io/package/pouchdb-plugin-error.md) 4.2.0
- [pouchdb-req-http-query](https://npm.io/package/pouchdb-req-http-query.md) 4.2.0

## Recent versions

- 4.2.0 (latest) — 2019-09-25
- 5.0.1-rc1.0 (beta) — 2025-08-27
- 4.1.0 — 2018-08-13
- 4.0.1 — 2018-06-05
- 4.0.0 — 2018-01-27
- 1.1.0 — 2016-02-04
- 1.0.6 — 2015-08-19
- 1.0.5 — 2015-01-13
- 1.0.4 — 2014-09-01
- 1.0.3 — 2014-07-06
- 1.0.2 — 2014-07-04
- 1.0.1 — 2014-06-05
- 1.0.0 — 2014-06-05

## 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.

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](http://guide.couchdb.org/draft/transforming.html).

### 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](http://docs.couchdb.org/en/latest/json-structure.html#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](http://docs.couchdb.org/en/latest/json-structure.html#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](https://github.com/babel/babel/blob/master/doc/design/monorepo.md).

For a full list of packages, see [the GitHub source](https://github.com/pouchdb/pouchdb-server/tree/master/packages/node_modules).

License
-------

The Apache 2 License. See [the LICENSE file](https://github.com/pouchdb/pouchdb-server/blob/master/LICENSE) for more information.

---
_Source: https://npm.io/package/pouchdb-list · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._