Skip to content
This repository has been archived by the owner on Aug 13, 2018. It is now read-only.

Latest commit

 

History

History
32 lines (24 loc) · 1.24 KB

README.md

File metadata and controls

32 lines (24 loc) · 1.24 KB

pouchdb-vhost

Build Status Dependency Status devDependency Status

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

#TODO: update, expand, rst -> md.

.. _pouchdb-vhost-plug-in:

PouchDB VirtualHost plug-in
===========================
+----------------------+------------------------+
| NodeJS package name: | `pouchdb-vhost`_       |
+----------------------+------------------------+
| Browser object name: | ``window.VirtualHost`` |
+----------------------+------------------------+

This plug-in is a single function which requires a ``PouchDB`` object as
its first argument. Following that, these extra methods become
available.

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

.. js:function:: PouchDB.virtualHost(req, vhosts[, options[, callback]])

.. js:function:: PouchDB.resolveVirtualHost(req, vhosts)