{"id":23705744,"url":"https://github.com/pouchdb/pouchdb-list","last_synced_at":"2025-09-03T11:30:56.151Z","repository":{"id":36712357,"uuid":"41018918","full_name":"pouchdb/pouchdb-list","owner":"pouchdb","description":"A PouchDB plug-in that allows you to re-use your CouchDB list functions on the client side.","archived":false,"fork":false,"pushed_at":"2017-07-17T16:43:13.000Z","size":21,"stargazers_count":1,"open_issues_count":25,"forks_count":6,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-04T13:21:28.713Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pouchdb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-19T07:07:44.000Z","updated_at":"2020-04-12T19:13:26.000Z","dependencies_parsed_at":"2022-09-25T01:41:17.126Z","dependency_job_id":null,"html_url":"https://github.com/pouchdb/pouchdb-list","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pouchdb/pouchdb-list","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouchdb%2Fpouchdb-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouchdb%2Fpouchdb-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouchdb%2Fpouchdb-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouchdb%2Fpouchdb-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pouchdb","download_url":"https://codeload.github.com/pouchdb/pouchdb-list/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouchdb%2Fpouchdb-list/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273436008,"owners_count":25105530,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-30T14:56:58.459Z","updated_at":"2025-09-03T11:30:55.853Z","avatar_url":"https://github.com/pouchdb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"pouchdb-list\n============\n\n[![Build Status](https://travis-ci.org/pouchdb/pouchdb-list.svg?branch=master)](https://travis-ci.org/pouchdb/pouchdb-list)\n[![Dependency Status](https://david-dm.org/pouchdb/pouchdb-list.svg)](https://david-dm.org/pouchdb/pouchdb-list)\n[![devDependency Status](https://david-dm.org/pouchdb/pouchdb-list/dev-status.svg)](https://david-dm.org/pouchdb/pouchdb-list#info=devDependencies)\n\nA PouchDB plug-in that allows you to re-use your CouchDB list functions\non the client side. A browser version is available.\n\nTODO: integrate, update \u0026 make nice:\n```rst\n.. _pouchdb-list-plug-in:\n\nPouchDB List plug-in\n====================\n+----------------------+-----------------+\n| NodeJS package name: | `pouchdb-list`_ |\n+----------------------+-----------------+\n| Browser object name: | ``window.List`` |\n+----------------------+-----------------+\n\nFirst, make sure you understand how list functions work in CouchDB. A\ngood start is `the CouchDB guide entry on lists`_.\n\n.. _pouchdb-list: https://www.npmjs.org/package/pouchdb-list\n.. _the CouchDB guide entry on lists: http://guide.couchdb.org/draft/transforming.html\n\n.. js:function:: List.list(listPath[, options[, callback]])\n\n   Runs a list function on a view. Both are specified via the\n   ``listPath`` parameter.\n\n   :param string listPath: a url of the form\n       ``\"designDocName/listFuncName/viewName\"``\n   :param object options: this object is supplemented with defaults\n       until a complete `CouchDB request object`_ has been formed, which\n       is then passed into the list function.\n   :returns: When succesful, the list function's result in the form of a\n       `CouchDB response object`_. Otherwise, an error object with one\n       of the following statuses: 400, 404, 406 or 500.\n\n.. _CouchDB request object: http://docs.couchdb.org/en/latest/json-structure.html#request-object\n.. _CouchDB response object: http://docs.couchdb.org/en/latest/json-structure.html#response-object\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpouchdb%2Fpouchdb-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpouchdb%2Fpouchdb-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpouchdb%2Fpouchdb-list/lists"}