# apeman-api-client

> Client for apeman api

Latest version **1.1.2** (published 2017-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install apeman-api-client
pnpm add apeman-api-client
yarn add apeman-api-client
bun add apeman-api-client
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2017-01-17 |
| First published | 2016-07-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | apeman, service |

## Links

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

## Dependencies (6)

- [co](https://npm.io/package/co.md) ^4.6.0
- [uuid](https://npm.io/package/uuid.md) ^2.0.2
- [asleep](https://npm.io/package/asleep.md) ^1.0.3
- [stringcase](https://npm.io/package/stringcase.md) ^3.0.1
- [eventsource](https://npm.io/package/eventsource.md) ^0.2.1
- [rfunc-client](https://npm.io/package/rfunc-client.md) ^2.0.9

## Recent versions

- 1.1.2 (latest) — 2017-01-17
- 1.1.1 — 2016-08-21
- 1.1.0 — 2016-08-21
- 1.0.19 — 2016-08-13
- 1.0.18 — 2016-08-08
- 1.0.17 — 2016-08-07
- 1.0.16 — 2016-08-07
- 1.0.15 — 2016-08-03
- 1.0.14 — 2016-08-03
- 1.0.13 — 2016-08-03
- 1.0.12 — 2016-08-03
- 1.0.11 — 2016-08-03
- 1.0.10 — 2016-08-02
- 1.0.9 — 2016-07-27
- 1.0.8 — 2016-07-26
- … 5 more at https://npm.io/package/apeman-api-client/versions

## README

apeman-api-client
==========

<!---
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-api-labo/apeman-api-client
[bd_travis_url]: http://travis-ci.org/apeman-api-labo/apeman-api-client
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-api-labo/apeman-api-client.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-api-labo/apeman-api-client
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-api-labo/apeman-api-client.svg?token=
[bd_license_url]: https://github.com/apeman-api-labo/apeman-api-client/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-api-labo/apeman-api-client
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-api-labo/apeman-api-client.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-api-labo/apeman-api-client.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-api-labo/apeman-api-client
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-api-labo/apeman-api-client.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-api-client
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-api-client.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>

Client for apeman api

<!-- 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-api-client --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
---------

```javascript
#!/usr/bin/env node

/**
 * This is an example of rfunc client
 */
'use strict'

const apemanApi = require('apeman-api-client')
const co = require('co')

co(function * () {
  let api = apemanApi('http://myapp.example.com')
  
  let sign = yield api.connect('sign') // Define a client

  // Call remote api and receive the result
  let { success } = yield sign.signin('foo', 'bar1234')
  console.log('success:', success)

  {
    // Access to scoped api
    let admin = api.of('@admin')
    let user = admin.user()
    yield user.destroy(1)
    /* ... */
  }
}).catch((err) => console.error(err))

```


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


<!-- Sections Start -->


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

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

<!-- LICENSE End -->


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

Links
------

+ [apeman][apeman_url]

[apeman_url]: https://github.com/apeman-labo/apeman

<!-- Links End -->

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