# appdotcouch

> Export global app.net stream to CouchDB

Latest version **0.2.0** (published 2012-08-16) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install appdotcouch
pnpm add appdotcouch
yarn add appdotcouch
bun add appdotcouch
```

Provides the command `appdotcouch`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2012-08-16 |
| First published | 2012-08-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Damien Klinnert |
| Maintainers | damienklinnert |
| Keywords | app, app.net, appdotnet, appnet, export, global, post, couchdb, dump, save |

## Links

- npm: https://www.npmjs.com/package/appdotcouch
- Repository: https://github.com/damienklinnert/appdotcouch
- npm.io page: https://npm.io/package/appdotcouch

## Dependencies (3)

- [appdotnet](https://npm.io/package/appdotnet.md) ~0.1.0
- [commander](https://npm.io/package/commander.md) ~1.0.1
- [couch-client](https://npm.io/package/couch-client.md) ~0.0.4

## Recent versions

- 0.2.0 (latest) — 2012-08-16
- 0.1.0 — 2012-08-15

## README

appdotcouch
===========

Export global app.net stream to CouchDB.

This is is a CLI, but you can also use it in your own node procjects. Be sure to checkout the api description at the bottom. 

**Important** You need a valid access token from app.net to use this tool.

**How to get an access token**

 * https://npmjs.org/package/appdotauth
 * https://github.com/appdotnet/api-spec/blob/master/auth.md#how-do-i-get-an-access-token



CLI
---

    Usage: appdotcouch [options]

    Options:

      -h, --help                    output usage information
      -V, --version                 output the version number
      --token [value]               app.net auth token
      --db [value]                  uri to couch db
      --uri [value]                 app.net api uri for global stream
      --sinceid [value]             api parameter since_id
      --beforeid [value]            api parameter before_id
      --count [value]               api parameter count
      --includeuser [value]         api parameter include_user
      --includeannotations [value]  api parameter include_annotations
      --includereplies [value]      api parameter include_replies



Developers
----------

Please make sure to include unit tests, if you want to contribute to this project.

To run the unit tests, there are several steps to do:

 1. install this package with `npm install -g appdotcouch`
 2. start your CouchDB and create a database
 3. register an application at https://alpha.app.net/developer/app/create/ (dev accounts only)
 4. `cp config.example.json config.json`
 5. insert your application details at `config.json`
 6. run tests with `npm test`



Examples
--------

### AppDotCouch
#### object.dump()
returns no error.

```js
client.dump(function (err) {
  should.not.exist(err);
  done();
});
```



API
---

### AppDotCouch()

Create a new AppDotCouch object with `token` and `filters`.

#### Params: 

* **String** *db* CouchDB uri

* **String** *token* app.net auth token

* **Object** *filters* for the request

#### Return:

* **Object** new AppDotCouch object

### AppDotCouch.create(db, token, filters)

Convenience constructor for `AppDotCouch`.

#### Params: 

* **String** *db* CouchDB uri

* **String** *token* app.net auth token

* **Object** *filters* for the request

#### Return:

* **Object** new AppDotCouch object

### object.dump(cb)

Dump the latest posts from app.net to CouchDB and callback `cb(err)`.

#### Params: 

* **Function** *cb*

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