9de94a264c
|
||
|---|---|---|
| .. | ||
| index.js | ||
| license | ||
| package.json | ||
| readme.md | ||
readme.md
state-toggle
Enter/exit a state.
Install
npm:
npm install state-toggle
Use
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
Function — enter.
enter()
Enter the state.
Context
If no ctx was given to toggle, the context object (this) of enter() is
used to toggle.
Returns
Function — exit.
exit()
Exit the state, reverting key to the value it had before entering.