Test

components/test : Test component

Test
Returns
HTMLElement: returns test component's node

Test

elements/test : Test elements

Test
Returns
HTMLElement: returns test element's node

routes

constants/routes.js : Routes constant

routes(): HTMLElement
Returns
HTMLElement: The matched component with the URL

test

containers/app/action.js : TEST action factory

test(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the test action object

test

containers/app/epic.js : test epic

test
Parameters
action$ (Object) stream of actions
store (Object) the main store to be used
dependencies (Object) the dependencies to be injected inside the epic
Name Description
dependencies.getJSON Function the rxjs getJSON function
dependencies.of Function the rxjs of function
Returns
Array: an array of actions to be dispatched

test

containers/home/action.js : HOME_TEST action factory

test(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the test action object

test

containers/home/epic.js : test epic

test
Parameters
action$ (Object) stream of actions
store (Object) the main store to be used
dependencies (Object) the dependencies to be injected inside the epic
Name Description
dependencies.getJSON Function the rxjs getJSON function
dependencies.of Function the rxjs of function
Returns
Array: an array of actions to be dispatched

testSuccess

containers/app/action.js : TEST_SUCCESS action factory

testSuccess(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the testSuccess action object

testSuccess

containers/home/action.js : HOME_TEST_SUCCESS action factory

testSuccess(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the testSuccess action object

testError

containers/app/action.js : TEST_ERROR action factory

testError(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the testError action object

testError

containers/home/action.js : HOME_TEST_ERROR action factory

testError(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the testError action object

testCancel

containers/app/action.js : TEST_CANCEL action factory

testCancel(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the testCancel action object

testCancel

containers/home/action.js : HOME_TEST_CANCEL action factory

testCancel(payload: any): Object
Parameters
payload (any) the payload of the action
Returns
Object: the testCancel action object

App

containers/app : App container

new App(props: Object)

Extends React.Component

Parameters
props (Object) the properties of the container
Name Description
props.app Object the redux state of the container
props.app.appData Object the appData property of the container

app

containers/app/reducer.js : app reducer

app(state: Object, action: Object): Object
Parameters
state (Object = initialState) the state of the app container
action (Object) the redux action instance
Returns
Object: returns the new state

Home

containers/home : Home container

new Home(props: Object)

Extends React.Component

Parameters
props (Object) the properties of the container
Name Description
props.home Object the redux state of the container
props.home.test Object the test property of the container

home

containers/home/reducer.js : home reducer

home(state: Object, action: Object): Object
Parameters
state (Object = initialState) the state of the home container
action (Object) the redux action instance
Returns
Object: returns the new state

asyncComponent

hoc/asyncComponent : calls the component asynchronously

asyncComponent(getComponent: Promise): class
Parameters
getComponent (Promise) a promise to load the file that returns a component
Returns
class: the loaded react component or null

reset

hoc/cleanOnUnmount/action.js : RESET action factory

reset(): Object
Returns
Object: the reset action object

mapStateToProps

hoc/cleanOnUnmount : maps state to props function

mapStateToProps(state: Object): Object
Parameters
state (Object) the state of the container
Returns
Object: state

mapStateToProps

hoc/reduxConnect : maps state to props function

mapStateToProps(state: Object): Object
Parameters
state (Object) the state of the container
Returns
Object: state

reduxConnect

hoc/cleanOnUnmount : connects state and actions to the component

reduxConnect(WrappedComponent: Object, actions: Object, state: Object): class
Parameters
WrappedComponent (Object) the react component that needs to be connected to the actions and state
actions (Object) the action factories of the component
state (Object = mapStateToProps) the state factory function
Returns
class: returns a react component

index

hoc/cleanOnUnmount : creates a wrapper over the component and dispatches the reset action on componentWillUnmount

index(WrappedComponent: Object, actions: Object, state: Object): class
Parameters
WrappedComponent (Object) the react component that needs to be connected to the actions and state
actions (Object) the action factories of the component
state (Object) the state factory function
Returns
class: returns the wrapped react component

index

hoc/passPropsToChild : passes properties to a single component

index(Component: class, props: Object): Function
Parameters
Component (class) the child component
props (Object) the properties to be assigned to the component
Returns
Function: a factory returning the component with assigned properties

index

hoc/passPropsToChildren : passes properties to a multiple component

index(ComponentsSet: Set, props: Object): Function
Parameters
ComponentsSet (Set) a set of child components
props (Object) the properties to be assigned to the components
Returns
Function: a factory returning the components with assigned properties

index

hoc/reduxConnect : connects state and actions to the component

index(WrappedComponent: Object, actions: Object, state: Object): class
Parameters
WrappedComponent (Object) the react component that needs to be connected to the actions and state
actions (Object) the action factories of the component
state (Object = mapStateToProps) the state factory function
Returns
class: returns a react component

reducer

hoc/cleanOnUnmount/reducer.js : the cleanOnUnmount HOC reducer factory

reducer(combinedReducers: Function): Function
Parameters
combinedReducers (Function) the current reducers factory of the component
Returns
Function: combination of the current reducer factory and the new (with reset functionality) reducer factory