https://github.com/pouchdb/pouchdb-update

A PouchDB plug-in that allows you to re-use your CouchDB update functions on the client side.
https://github.com/pouchdb/pouchdb-update

Last synced: 5 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/pouchdb/pouchdb-update
• Owner: pouchdb
• Created: 2015-08-19T08:51:11.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-03-07T08:31:46.000Z (over 8 years ago)
• Last Synced: 2024-11-07T07:35:28.858Z (7 months ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 4
• Watchers: 11
• Forks: 4
• Open Issues: 25
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
pouchdb-update

==============

[![Build Status](https://travis-ci.org/pouchdb/pouchdb-update.svg?branch=master)](https://travis-ci.org/pouchdb/pouchdb-update)

[![Dependency Status](https://david-dm.org/pouchdb/pouchdb-update.svg)](https://david-dm.org/pouchdb/pouchdb-update)

[![devDependency Status](https://david-dm.org/pouchdb/pouchdb-update/dev-status.svg)](https://david-dm.org/pouchdb/pouchdb-update#info=devDependencies)

A PouchDB plug-in that allows you to re-use your CouchDB update

functions on the client side. A browser version is available.

TODO: convert the following to markdown + update + make nicer

```rst

.. _pouchdb-update-plug-in:

PouchDB Update plug-in

======================

+----------------------+-------------------+

| NodeJS package name: | `pouchdb-update`_ |

+----------------------+-------------------+

| Browser object name: | ``window.Update`` |

+----------------------+-------------------+

First, make sure you understand how update handlers work in CouchDB. A

good start is `the wiki entry on update handlers`_.

.. _pouchdb-update: https://www.npmjs.org/package/pouchdb-update

.. _the wiki entry on update handlers: https://wiki.apache.org/couchdb/Document_Update_Handlers

.. js:function:: Update.update(updatePath[, options[, callback]])

   Runs the update function specified by ``updatePath``, saving part of

   its result in the database and returning the other part in the form

   of a CouchDB response object.

   :param string updatePath: has the following form:

       ``"designDocName/updateHandlerName[/docId]"``. The last being

       optional, like in CouchDB.

   :param object options: a request object stub. There's also

       ``options.withValidation``, if true, this function saves the

       update handler result using the

       :js:func:`Validation.validatingPut` function instead of using the

       :js:func:`PouchDB.prototype.put` function.

```