Nybble Processing Mainframe
    Have ideas to improve npm?Join in the discussion! »

    state-toggle
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    state-toggle

    Build Coverage Downloads Size

    Enter/exit a state.

    Install

    npm:

    npm install state-toggle

    Use

    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) // => false

    API

    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

    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

    2,872,696

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    5.91 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar