brain-freeze v1.1.9
Brain Freeze
#Synopsis
Brainfreeze takes advantage of redux architecture. That means that a lot of how Brainfreeze works is very similar to how redux, or a redux-like library works. The basic structure of Brainfreeze follows the dispatch an action => reducer => update/change state => return a new state.
Brainfreeze still follows the functional approach that redux follows, we feel that is an appropriate approach to state containers.
Where does Brainfreeze differentiate itself?
Brainfreeze saw an issue where as applications scaled, the amount of 'listeners' on the page that were reacting to a state change could become taxing on performance. Brainfreeze focuses on the developer gaining more control over the their application state. We allow for this by creating a flattened state model that is able to create a mapping of the state object. By doing this we allow specific pieces of state to map to their specific listener. The listener now will only react to the changes that are neccessary to them when state is set.
Doing this, we also enabled middleware functionality for more control over the state object. By creating this model, we set out create less business logic needed in the reducers and create more room for the developer to code what they want to code, and let the library hash out the unwanted logic. We are excited to dive into the depths of what Brainfreeze can do.
#API Reference Brainfreeze aims to provide a familiar and predictable state container.
#Installation npm i brain-freeze --save
#Documentation CombineReducers optional:action.types:string : Void Adds reducers to be run on state on invocation of dispatch. The reducer object should take the same shape as the state object.
Object returns state````
````Dispatch : Object
Takes in action objects and checks for lock related commands (see locked state) before running state through reducers````
````Subscribe : Function
Subscribes a listener function to state changes (globally or to a specific key path)
and returns a function to unsubscribe the same listener function.
In order to subscribe to a specific key path, the developer must pass in a second argument after the listener,
that is the key path within the state object, as a string. This must be done in dot notation, even with arrays.````
```` Actions are generally made by the developer. These are strings that are dispatched to a reducer, that tells the reducer what to do. Brain-Freeze comes with a few of these out of the box to take
full advantage of what the library has to offer.````
Lock State
By attaching a 'lockState' property to the action object upon dispatch, the dispatch method will lock the state
and refuse to change state until it receives an action object with the 'unlockState' property. If the
dispatch method sees the 'lockState' or 'unlockState' property it will lock or unlock state respectively,
and then exit.
````Locking Specific Key Paths
Locking specific keys gives the developer the ability to make pieces of state immutable.
This is done by dispatching an action, called 'lockKeys'. If an action is dispatched to this key while it's leave of state is locked, the action will be intercepted and the change will not occur
In certain modes, like dev-mode, the console will log out that the key is locked, and will give the developer some feedback.````
# Under The Hood
````Get ALl Keys : Function
Returns flattened object from nested object````
````Key Paths Changed : Function
Returns array of keys from obj1 that are not the same in obj2. Will not return keys from obj2 that are not in obj1.````
````Save History : Function
Saves a history of state in the form of an array of deep cloned, deep frozen copies.````
## Tests
To Come ...
## Contributors
[](https://github.com/Eviscerare)
[](https://github.com/soleiluwedu)
[](https://github.com/ryanbas21)
## License
MIT