# apeman-app-peer

> apeman app for peer server.

Latest version **2.0.1** (published 2016-05-16) · MIT license · 0 weekly downloads

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

## Install

```sh
npm install apeman-app-peer
pnpm add apeman-app-peer
yarn add apeman-app-peer
bun add apeman-app-peer
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2016-05-16 |
| First published | 2016-03-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | apeman, app, peer |

## Links

- npm: https://www.npmjs.com/package/apeman-app-peer
- Repository: https://github.com/apeman-app-labo/apeman-app-peer
- Homepage: https://github.com/apeman-app-labo/apeman-app-peer#readme
- Issues: https://github.com/apeman-app-labo/apeman-app-peer/issues
- npm.io page: https://npm.io/package/apeman-app-peer

## Dependencies (7)

- [co](https://npm.io/package/co.md) ^4.6.0
- [peer](https://npm.io/package/peer.md) ^0.2.8
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [objnest](https://npm.io/package/objnest.md) ^2.0.5
- [apemanport](https://npm.io/package/apemanport.md) ^1.0.0
- [colorprint](https://npm.io/package/colorprint.md) ^3.0.3
- [http-proxy](https://npm.io/package/http-proxy.md) ^1.13.3

## Recent versions

- 2.0.1 (latest) — 2016-05-16
- 2.0.0 — 2016-05-01
- 1.0.4 — 2016-03-16
- 1.0.3 — 2016-03-10
- 1.0.2 — 2016-03-09
- 1.0.1 — 2016-03-09
- 1.0.0 — 2016-03-09

## README

apeman-app-peer
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-app-labo/apeman-app-peer
[bd_travis_url]: http://travis-ci.org/apeman-app-labo/apeman-app-peer
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-app-labo/apeman-app-peer.svg?style=flat
[bd_license_url]: https://github.com/apeman-app-labo/apeman-app-peer/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-app-labo/apeman-app-peer
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-app-labo/apeman-app-peer.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-app-labo/apeman-app-peer.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-app-labo/apeman-app-peer
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-app-labo/apeman-app-peer.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-app-peer
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-app-peer.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

apeman app for peer server.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>
Installation
-----

```bash
$ npm install apeman-app-peer --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>
Usage
---------

1. Define an app within Apemanfile.js
2. Call the app via apeman app command.

**Apemanfile.js**
```javascript
/** This is an example Apemanfile to use apeman-app-peer */

'use strict'

module.exports = {
  $pkg: { /* ... */ },
  $apps: {
    // Define your own app.
    'my-app-01': {
      // Map url and handlers.
      '/api/peer': [
        require('apeman-app-peer')({
          // Options
          port: 9000
        })
      ]
    }
  }
}

```

Then,
```bash
$ apeman app my-app-01 -p 3000
```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->

<a name="section-doc-guides-03-signature-md"></a>
Signature
-------

#### apemanAppPeer(options) -> function

apeman app for peer server.

##### Args

| Name | Type | Default | Description |
| --- | ---- | --- | --- |
| options | object  |  | Optional settings. |
| options.port | number  |  | Port number |


<!-- Section from "doc/guides/03.Signature.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-app-labo/apeman-app-peer/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman](https://github.com/apeman-labo/apeman)
+ [peerjs-server](https://github.com/peers/peerjs-server)
+ [apeman-app](https://github.com/apeman-cmd-labo/apeman-app)

<!-- Links End -->

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