@heridux/core

Table of Contents

• Heridux
  • Parameters
  • set
    • Parameters
  • getState
    • Parameters
  • get
    • Parameters
  • getIn
    • Parameters
    • Examples
  • setInitialState
    • Parameters
  • createAction
    • Parameters
    • Examples
  • execAction
    • Parameters
  • register
  • dispatch
    • Parameters

Heridux

Creation of Heridux store

Parameters

• STATE_PROPERTY String string name for this slice of state. Generated actions wille use this as a prefix.

set

Set a first level value without creating a specific action

Parameters

• prop String property name
• value any property value

Returns undefined

getState

Get store slice

Parameters

• state Immutable.Map? global state (if not specified, call getState method of redux store)

Returns Immutable.Map store slice

get

Get js value of a first level key

Parameters

• key String key name
• state Immutable.Map? global state (if not specified, call getState method of redux store)

Returns any key value (converted in plain js if immutable)

getIn

• **See: https://immutable-js.github.io/immutable-js/ **

Get js value of a nested key

Parameters

• path Array Iterable key path (more details in Immutable.js documentation)
• state Immutable.Map? global state (if not specified, call getState method of redux store)

Examples

const store = new Heridux("myPartialStore")
store.setInitialState({
 list : [{ name : "foo"}, { name : "bar" }]
})
store.getIn(["list", 0, "name"]) // foo

Returns any key value (converted in plain js if immutable)

setInitialState

Define the initial state of the store slice. It will automatically be converted to immutable.

Parameters

• state Object plain js state

Returns undefined

createAction

Create action/reducer couple

Parameters

• name String action short name
• reducer Function function to modify the state

Examples

const myStore = new Heridux("myPartialStore")

myStore.setInitialState({
 list : ["foo", "bar"]
})

myStore.createAction("pop", state => state.update("list", arr => arr.pop())

myStore.execAction("pop")

myStore.get("list") //  ["foo"]

Returns undefined

execAction

• **See: createAction **

Execute action registered by createAction method

Parameters

• name String action short name
• options Object additional parameters

Returns undefined

register

Register heridux store in global redux store

Returns undefined

dispatch

dispatch any action on global redux store

Parameters

• action (Object | Function) redux action

Returns (undefined | Promise) promise if async