# apeman-service-toggle

> Service for toggle.

Latest version **2.0.1** (published 2017-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install apeman-service-toggle
pnpm add apeman-service-toggle
yarn add apeman-service-toggle
bun add apeman-service-toggle
```

## 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 | 2.0.1 |
| Published | 2017-02-12 |
| First published | 2016-10-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | apeman, service |

## Links

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

## Dependencies (4)

- [co](https://npm.io/package/co.md) ^4.6.0
- [abind](https://npm.io/package/abind.md) ^1.0.3
- [debug](https://npm.io/package/debug.md) ^2.6.1
- [apeman-service-base](https://npm.io/package/apeman-service-base.md) ^2.0.1

## Recent versions

- 2.0.1 (latest) — 2017-02-12
- 2.0.0 — 2017-02-12
- 1.1.4 — 2016-10-12
- 1.1.3 — 2016-10-11
- 1.1.2 — 2016-10-11
- 1.1.1 — 2016-10-11
- 1.1.0 — 2016-10-11
- 1.0.0 — 2016-10-11

## README

apeman-service-toggle
==========

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

Service for toggle.

<!-- 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-service-toggle --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

'use strict'

const { ApToggleService } = require('apeman-service-toggle')
const { createStore } = require('redux')

{
  let store = createStore({ /* ... */ })
  let service = new ApToggleService(store)
}
```


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

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

<a name="section-doc-guides-03-a-p-i-md"></a>

API
---------

# apeman-service-toggle@2.0.0

Service for toggle.

+ Functions
  + [create(args)](#apeman-service-toggle-function-create)
+ [ApToggleService](apeman-service-toggle-classes) Class
  + [new ApToggleService(store, options)](#apeman-service-toggle-classes-ap-toggle-service-constructor)
  + [service.getToggle(toggleName)](#apeman-service-toggle-classes-ap-toggle-service-getToggle)
  + [service.turnToggle(toggleName, flg)](#apeman-service-toggle-classes-ap-toggle-service-turnToggle)
  + [service.turnOffToggle(toggleName)](#apeman-service-toggle-classes-ap-toggle-service-turnOffToggle)
  + [service.turnOnToggle(toggleName)](#apeman-service-toggle-classes-ap-toggle-service-turnOnToggle)

## Functions

<a class='md-heading-link' name="apeman-service-toggle-function-create" ></a>

### create(args) -> `ApToggleService`

Create the service instance

| Param | Type | Description |
| ----- | --- | -------- |
| args | * |  |



<a class='md-heading-link' name="apeman-service-toggle-classes"></a>

## ApToggleService Class

Service


<a class='md-heading-link' name="apeman-service-toggle-classes-ap-toggle-service-constructor" ></a>

### new ApToggleService(store, options)

Constructor of ApToggleService class

| Param | Type | Description |
| ----- | --- | -------- |
| store | Object | Redux store |
| options | Object | Optional settings |


<a class='md-heading-link' name="apeman-service-toggle-classes-ap-toggle-service-getToggle" ></a>

### service.getToggle(toggleName) -> `boolean`

Get goggle value

| Param | Type | Description |
| ----- | --- | -------- |
| toggleName | string | Name of toggle |


<a class='md-heading-link' name="apeman-service-toggle-classes-ap-toggle-service-turnToggle" ></a>

### service.turnToggle(toggleName, flg) -> `Promise`

Turn toggle value

| Param | Type | Description |
| ----- | --- | -------- |
| toggleName | string | Name of toggle |
| flg | boolean |  |


<a class='md-heading-link' name="apeman-service-toggle-classes-ap-toggle-service-turnOffToggle" ></a>

### service.turnOffToggle(toggleName) -> `Promise`

Turn toggle to off

| Param | Type | Description |
| ----- | --- | -------- |
| toggleName | string | Name of toggle |


<a class='md-heading-link' name="apeman-service-toggle-classes-ap-toggle-service-turnOnToggle" ></a>

### service.turnOnToggle(toggleName) -> `Promise`

Turn toggle to on

| Param | Type | Description |
| ----- | --- | -------- |
| toggleName | string | Name of toggle |







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


<!-- Sections Start -->


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

License
-------
This software is released under the [MIT License](https://github.com/apeman-service-labo/apeman-service-toggle/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-service-toggle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._