Package Exports
- state-toggle
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (state-toggle) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
state-toggle
Enter/exit a state.
Install
npm:
npm install state-toggleUse
import {stateToggle} from 'state-toggle'
var ctx = {on: false}
var enter = stateToggle('on', ctx.on, ctx)
var exit
// Entering:
exit = enter()
console.log(ctx.on) // => true
// Exiting:
exit()
console.log(ctx.on) // => falseAPI
state-toggle exports the following identifier: stateToggle.
There is no default export.
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.