# justo-plugin-pouchdb

> Plugin for PouchDB and PouchDB Server.

Latest version **0.1.0** (published 2016-04-27) · 0 weekly downloads

## Install

```sh
npm install justo-plugin-pouchdb
pnpm add justo-plugin-pouchdb
yarn add justo-plugin-pouchdb
bun add justo-plugin-pouchdb
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-04-27 |
| First published | 2016-04-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 5.0.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Justo Labs |
| Maintainers | justojs |
| Keywords | CouchDB, Justo, Justo.js, justo-plugin, PouchDB, PouchDB Server |

## Links

- npm: https://www.npmjs.com/package/justo-plugin-pouchdb
- Repository: https://github.com/justojsp/justo-plugin-pouchdb
- Homepage: http://justojs.org
- Issues: https://github.com/justojsp/justo-plugin-pouchdb/issues
- npm.io page: https://npm.io/package/justo-plugin-pouchdb

## Dependencies (5)

- [pouchdb](https://npm.io/package/pouchdb.md) *
- [justo-fs](https://npm.io/package/justo-fs.md) *
- [memorystream](https://npm.io/package/memorystream.md) *
- [pouchdb-load](https://npm.io/package/pouchdb-load.md) *
- [pouchdb-replication-stream](https://npm.io/package/pouchdb-replication-stream.md) *

## Recent versions

- 0.1.0 (latest) — 2016-04-27

## README

[![Build Status](https://travis-ci.org/justojsp/justo-plugin-pouchdb.svg?branch=master)](https://travis-ci.org/justojsp/justo-plugin-pouchdb)
[![Dependency Status](https://david-dm.org/justojsp/justo-plugin-pouchdb.svg)](https://david-dm.org/justojsp/justo-plugin-pouchdb)
[![devDependency Status](https://david-dm.org/justojsp/justo-plugin-pouchdb/dev-status.svg)](https://david-dm.org/justojsp/justo-plugin-pouchdb#info=devDependencies)

Plugin for *PouchDB* and *PouchDB Server*.

*Proudly made with ♥ in Valencia, Spain, EU.*

## Install

```
npm install justo-plugin-pouchdb
```

## Use

```
const pouchdb = require("justo-plugin-pouchdb");
```

## Tasks


This plugin is composite.

### installServer task

Install *PouchDB Server* globally:

```
installServer(opts : object, config ?: object)
```

The `config` parameter:

- `version` (string). The version to install. Default: `*`.
- `output` (boolean). Show the output. Default: `true`.

Example:

```
pouchdb.installServer("Install PouchDB Server", {version: "1.1.1"});
```

### uninstallServer task

Uninstall *PouchDB Server* globally:

```
uninstallServer(opts : object, config ?: object) : boolean
```

The `config` parameter:

- `output` (boolean). Show the output. Default: `true`.

Example:

```
pouchdb.uninstallServer("Uninstall PouchDB Server");
```

### startServer task

Start the *PouchDB Server*:

```
startServer(opts : object, config ?: object) : boolean
```

The `config` parameter:

- `host` (string). The hostname. Default: `localhost`.
- `port` (number). The port number. Default: `5984`.
- `dir` (string). The data directory.
- `config` (string). The configuration file path.
- `log` (boolean). If log must be generated. Default: `true`.
- `pidFile` (string). The PID file path. Default: none.
- `type` (string). The *PouchDB Server* type:
  - `in-memory`. In-memory database server.
  - `disk`. In disk database server. Default.
  - `backend`. Database server talks to another server.
  - `proxy`. Database server proxies to another host.
- `disk` (string). If `type=disk`, the storage engine: `SQLite` or `LevelDOWN`. Default: `LevelDOWN`.
- `backend` (string). If `type=backend`, the backend. For example: `memdown`, `riakdown`, `redisdown`, etc.
- `proxy` (string). If `type=proxy`, the host to proxy the requests.
- `wd` (string). Working dir. Default: `.`.

Example:

```
pouchdb.startServer("Start PouchDB Server", {
  host: "localhost",
  port: 5984,
  dir: "/opt/pouchdb-server/data",
  config: "/opt/pouchdb-server/pouchdb-server.json",
  type: "disk",
  disk: "LevelDOWN",
  log: true,
  pidFile: "/opt/pouchdb-server/pouchdb-server.pid",
  wd: "/opt/pouchdb-server/"
});
```

### ping task

Ping a *PouchDB/CouchDB server*:

```
ping(opts : object, config : object) : boolean
```

The `config` parameter:

- `protocol` (string). The protocol to use: `http` or `https`. Default: `http`.
- `host` (string). The host. Default: `localhost`.
- `port` (number). The port number. Default: `5984`.
- `db` (string). The database name.
- `username` (string). The username.
- `password` (string). The user password.

### dump task

Dump a *PouchDB/CouchDB server* database:

```
dump(opts : object, config : object) : boolean
```

The `config` parameter:

- `protocol` (string). The protocol to use: `http` or `https`. Default: `http`.
- `host` (string). The host. Default: `localhost`.
- `port` (number). The port number. Default: `5984`.
- `db` (string). The database name.
- `dst` (string). The dump file.
- `username` (string). The username.
- `password` (string). The user password.

Example:

```
pouchdb.dump("Dump test database", {
  protocol: "https",
  host: "localhost",
  port: 5984,
  db: "test",
  dst: "/opt/pouchdb-server/dump/test.dmp"
})
```

### load task

Load a database dump into a database:

```
load(opts : object, config : object) : boolean
```

The `config` parameter:

- `protocol` (string). The protocol to use: `http` or `https`. Default: `http`.
- `host` (string). The host. Default: `localhost`.
- `port` (number). The port number. Default: `5984`.
- `db` (string). The database name.
- `src` (string). The dump file.
- `username` (string). The username.
- `password` (string). The user password.

Example:

```
pouchdb.load("Load test database", {
  protocol: "https",
  host: "localhost",
  port: 5984,
  db: "test",
  src: "/opt/pouchdb-server/dump/test.dmp"
})
```

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