DOCUMENTATION.md

Modules

connect

createStore ⇒ Node | function

Creates an global store.

provider

connect

connect~actionCallback(actionCallback)

To dispatch values to global store.

Kind: inner method of connect

Param	Type	Description
actionCallback	function	A function that receives dispatch function as a param

createStore ⇒ Node | function

Creates an global store.

Returns: Node - - Returns a wrapper provider componentfunction - - A "connect" function to connect a component with global state

Param	Type	Description
defaultState	Object	The default state of the application need to create the store

• createStore ⇒ Node | function
  • ~dispatch(options)
  • ~connect(select, component) ⇒ Node

createStore~dispatch(options)

To update values in global store.

Kind: inner method of createStore

Param	Type	Description
options	Object	A object with the details to update values in global store
options.key	string	KeyPath to which the value has to be assigned, separated by '.'
options.payload	Object	Value to be set against the provided Keypath

createStore~connect(select, component) ⇒ Node

Connects the passed component with the global store.

Kind: inner method of createStore
Returns: Node - - A wrapper React element

Param	Type	Description
select	function	To map global state to props, should return an JSON object
component	Node	A React element, to which the props has to be passed

provider

• provider
  • ~Provider
    • new Provider()

provider~Provider

Kind: inner class of provider
Properties

Name	Type	Description
defaultState	object	The default state of the application need to create the store, if not passed as part of createStore
children	Node	React element for which the store should be made available

new Provider()

Provider Component.