Nobody Publish Monsters
Publish your own packages to the world's most popular software ecosystem with npm Pro.Get started »

state-toggle

1.0.2 • Public • Published

state-toggle

Build Coverage Downloads Size

Enter/exit a state.

Installation

npm:

npm install state-toggle

Usage

var toggle = require('state-toggle')
 
var ctx = {on: false}
var enter = toggle('on', ctx.on, ctx)
var exit
 
// Entering:
exit = enter()
console.log(ctx.on) // => true
 
// Exiting:
exit()
console.log(ctx.on) // => false

API

toggle(key, initial[, ctx])

Create a toggle, which when entering toggles key on ctx (or this, if ctx is not given) to !initial, and when exiting, sets key on the context back to the value it had before entering.

Returns

Functionenter.

enter()

Enter the state.

Context

If no ctx was given to toggle, the context object (this) of enter() is used to toggle.

Returns

Functionexit.

exit()

Exit the state, reverting key to the value it had before entering.

License

MIT © Titus Wormer

Install

npm i state-toggle

DownloadsWeekly Downloads

1,714,019

Version

1.0.2

License

MIT

Unpacked Size

4.96 kB

Total Files

4

Last publish

Collaborators

  • avatar