ba73a67d45
PR-URL: https://github.com/nodejs/node/pull/16738 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> |
||
|---|---|---|
| .. | ||
| history.md | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| readme.md | ||
state-toggle 
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
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.