# apeman-app-flush

> apeman app to handle flush messages.

Latest version **3.0.1** (published 2016-06-11) · MIT license · 0 weekly downloads

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

## Install

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

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2016-06-11 |
| First published | 2016-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | apeman, app, flush |

## Links

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

## Dependencies (2)

- [co](https://npm.io/package/co.md) ^4.6.0
- [debug](https://npm.io/package/debug.md) ^2.2.0

## Recent versions

- 3.0.1 (latest) — 2016-06-11
- 2.0.0 — 2016-04-30
- 1.0.0 — 2016-02-15

## README

apeman-app-flush
==========

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

<!-- 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-flush --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-flush */

'use strict'

const co = require('co')

module.exports = {
  $pkg: { /* ... */ },
  $apps: {
    'my-app-01': {
      '/': [
        // flush middleware needs session store.
        require('apeman-app-session')({
          /* ... */
        }),
        // Add flush
        require('apeman-app-flush')({}),
        co.wrap(function * (ctx, next) {
          // Push flush message.
          ctx.flush('Say hey!')
          /* ... */
          yield next()
        }),
        (ctx) => {
          // Shift flush message.
          let msg = ctx.flush()
          /* ... */
        }
      ]
    }
  }
}

```

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
-------

#### apemanAppFlush(options) -> function

apeman app to handle flush messages.

##### Args

| Name | Type | Default | Description |
| --- | ---- | --- | --- |
| options | object  |  | Optional settings. |


<!-- 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-flush/blob/master/LICENSE).

<!-- LICENSE End -->


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

Links
------

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

<!-- Links End -->

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