pouchdb/pouchdb-rewrite

Name: pouchdb-rewrite

Owner: PouchDB

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

Created: 2015-08-19 08:48:31.0

Updated: 2016-02-05 10:37:23.0

Pushed: 2017-03-07 08:23:02.0

Homepage: null

Size: 22

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

pouchdb-rewrite

A PouchDB plug-in that allows you to re-use your CouchDB rewrites on the client side. A browser version is available.

TODO: update, rst -> md, integrate

pouchdb-rewrite-plug-in:

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

t, make sure you understand CouchDB rewrites. A good starting point
the rewrite documentation`_.

pouchdb-rewrite: https://www.npmjs.org/package/pouchdb-rewrite
the rewrite documentation: http://docs.couchdb.org/en/latest/api/ddoc/rewrites.html

s:function:: Rewrite.rewrite(rewritePath[, options[, callback]])

igures out where to redirect to, and then executes the corresponding
ouchDB function, with the appropriate arguments gotten from the
equest object that has been generated from the ``options``
arameter.

param string rewritePath: a path of the form
   ``"designDocName/rewrite/path"``. Specifies the design document
   to use the rewrites from, and the path you'd find in CouchDB
   after the ``/_rewrite`` part of the URL. Keep in mind that you
   can't specify a query parameter in the url form (i.e. no
   ``?a=b``). Instead use the ``options.query`` parameter.
param object options: A CouchDB request object stub. Important
   properties of those for rewrites are ``options.query`` and
   ``options.method``. An additional boolean option is available:
   ``options.withValidation``, if true, this function routes to
   ``db.validating*`` functions instead of ``db.*`` functions if
   relevant.
returns: whatever output the function that the rewrite routed to
   produced. Or, in the case of an 'http' database, a CouchDB
   response object.

s:function:: Rewrite.rewriteResultRequestObject(rewritePath[, options[, callback]])

ee the :js:func:`Rewrite.rewrite` function for information on the
arameters. The difference with it is that this function doesn't try
o route the rewrite to a function.

returns: A CouchDB request object that points to the resource
   obtained by following the redirect.