Skip to content
Enter/exit a state
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig
.gitignore
.npmrc
.prettierignore
.travis.yml
funding.yml
index.js
license
package.json
readme.md
test.js

readme.md

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

You can’t perform that action at this time.