# toggle-state

> Toggle state.

Latest version **1.2.0** (published 2018-06-27) · MIT license · 0 weekly downloads

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

## Install

```sh
npm install toggle-state
pnpm add toggle-state
yarn add toggle-state
bun add toggle-state
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2018-06-27 |
| First published | 2018-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pig Fang |
| Maintainers | gplane |

## Links

- npm: https://www.npmjs.com/package/toggle-state
- Repository: https://github.com/g-plane/toggle-state
- npm.io page: https://npm.io/package/toggle-state

## Recent versions

- 1.2.0 (latest) — 2018-06-27
- 1.1.0 — 2018-04-18
- 1.0.0 — 2018-04-18

## README

# toggle-state

Toggle state.

[![Travis](https://img.shields.io/travis/g-plane/toggle-state.svg?style=flat-square)](https://travis-ci.org/g-plane/toggle-state)
[![Codecov](https://img.shields.io/codecov/c/github/g-plane/toggle-state.svg?style=flat-square)](https://codecov.io/gh/g-plane/toggle-state)
[![License](https://img.shields.io/github/license/g-plane/toggle-state.svg?style=flat-square)](https://github.com/g-plane/toggle-state/blob/master/LICENSE)
[![NPM Version](https://img.shields.io/npm/v/toggle-state.svg?style=flat-square)](https://www.npmjs.com/package/toggle-state)
[![NPM Downloads](https://img.shields.io/npm/dm/toggle-state.svg?style=flat-square)](https://www.npmjs.com/package/toggle-state)

## Installation

Using Yarn:

```bash
$ yarn add toggle-state
```

Using npm:

```bash
$ npm install toggle-state
```

## Usage

```javascript
import { toggle, togglify } from 'toggle-state'

const state = false
toggle(state, true, false)  //=> true

const switcher = togglify(state, true, false)
switcher()  //=> true
switcher()  //=> false
```

## License

MIT License

Copyright (c) 2018-present Pig Fang

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