artskydj/state-holder

Basic getter and setter for arbitrary data

state-holder

Basic getter and setter for arbitrary data

source code

I think the best way to describe this module is to show you its source code:

module.exports = function StateHolder(thing) {
	return {
		get: function get() { return thing },
		set: function set(x) { return thing = x }
	}
}

That's it! Short and sweet!

why

Perhaps you're saying "This is the dumbest module I've ever seen!" Well, maybe it is, but it solved a problem for me. You can pass either state.set or state.get to another function, and it can only set data or get data, but not vise versa.

example

And a quick example of how to use it:

var StateHolder = require('state-holder')

var state = StateHolder( 'hello' )
state.get() // => 'hello'

state.set() // => undefined
state.get() // => undefined

state.set('world') // => 'world'
state.get() // => 'world'

api

var StateHolder = require('state-holder')

var state = StateHolder( [thing] )

Can be called with or without new.

The state is set to the value of thing. If thing is omitted, the state is set to undefined.

var thing = state.get()

Returns the state.

state.set( [thing] )

The state is set to the value of thing. If thing is omitted, the state is set to undefined. Whatever the state ends up being set to is returned.

install

npm install state-holder

license

VOL