Function

Static Public Summary
public	addItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to add item to end of list
public	addItemsAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to add items to end of list
public	decrementNumberAction(param: Object): {meta: {reducerName: String}, type: String} action creator to decrement number
public	incrementNumberAction(param: Object): {meta: {reducerName: String}, type: String} action creator to increment number
public	insertItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to insert item
public	removeItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to remove item
public	removeItemByKeyAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to remove item by key
public	resetBooleanAction(param: Object): {meta: {reducerName: String}, type: String} action creator to reset boolean to original state
public	resetListAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to reset list
public	resetNumberAction(param: Object): {meta: {reducerName: String}, type: String} action creator to reset number
public	resetObjectAction(param: Object): {meta: {reducerName: String}, type: String} action creator to reset object to original state
public	resetStringAction(param: Object): {meta: {reducerName: String}, type: String} action creator to reset string to original state
public	setBooleanAction(param: Object): {payload: Boolean, meta: {reducerName: String}, type: String} action creator to set boolean
public	setListAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to set list
public	setNumberAction(param: Object): {payload: Number, meta: {reducerName: String}, type: String} action creator to set number
public	setObjectAction(param: Object): {payload: String, meta: {reducerName: String}, type: String} action creator to set object
public	setStringAction(param: Object): {payload: String, meta: {reducerName: String}, type: String} action creator to set string
public	toggleBooleanAction(param: Object): {meta: {reducerName: String}, type: String} action creator to toggle boolean
public	updateItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to update item
public	updateItemByKeyAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to update item by key
public	updateItemsByKeyAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to update items by key
public	updateObjectAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to update object
public	updateValueAllItemsAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} action creator to update a value in all items in the reducer

Static Public

public addItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {addItemAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to add item to end of list

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to add item to
param.item	Object		item to add to end of list
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public addItemsAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {addItemsAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to add items to end of list

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to add items to
param.items	Object		items to add to end of list
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public decrementNumberAction(param: Object): {meta: {reducerName: String}, type: String} source

import {decrementNumberAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/number/number.actions.js'

action creator to decrement number

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to decrement number
param.meta	Object	optional	additional meta fields

Return:

{meta: {reducerName: String}, type: String}

public incrementNumberAction(param: Object): {meta: {reducerName: String}, type: String} source

import {incrementNumberAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/number/number.actions.js'

action creator to increment number

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to increment number
param.meta	Object	optional	additional meta fields

Return:

{meta: {reducerName: String}, type: String}

public insertItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {insertItemAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to insert item

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to insert item
param.item	Object		item to insert
param.index	Number		index to insert item at
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public removeItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {removeItemAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to remove item

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to remove item
param.index	Number		index to remove item at
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public removeItemByKeyAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {removeItemByKeyAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to remove item by key

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to remove item by key
param.item	Object		item to remove by key
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public resetBooleanAction(param: Object): {meta: {reducerName: String}, type: String} source

import {resetBooleanAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/boolean/boolean.actions.js'

action creator to reset boolean to original state

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to reset boolean
param.meta	Object	optional	additional meta fields

Return:

{meta: {reducerName: String}, type: String}

public resetListAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {resetListAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to reset list

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to reset list
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public resetNumberAction(param: Object): {meta: {reducerName: String}, type: String} source

import {resetNumberAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/number/number.actions.js'

action creator to reset number

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to reset number
param.meta	Object	optional	additional meta fields

Return:

{meta: {reducerName: String}, type: String}

public resetObjectAction(param: Object): {meta: {reducerName: String}, type: String} source

import {resetObjectAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/object/object.actions.js'

action creator to reset object to original state

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to reset object
param.meta	Object	optional	additional meta fields

Return:

{meta: {reducerName: String}, type: String}

public resetStringAction(param: Object): {meta: {reducerName: String}, type: String} source

import {resetStringAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/string/string.actions.js'

action creator to reset string to original state

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to reset string
param.meta	Object	optional	additional meta fields

Return:

{meta: {reducerName: String}, type: String}

public setBooleanAction(param: Object): {payload: Boolean, meta: {reducerName: String}, type: String} source

import {setBooleanAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/boolean/boolean.actions.js'

action creator to set boolean

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to set boolean
param.boolean	Boolean		value to set reducer to
param.meta	Object	optional	additional meta fields

Return:

{payload: Boolean, meta: {reducerName: String}, type: String}

Throw:

Error

Action payload must be of type Boolean

public setListAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {setListAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to set list

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to set list
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public setNumberAction(param: Object): {payload: Number, meta: {reducerName: String}, type: String} source

import {setNumberAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/number/number.actions.js'

action creator to set number

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to set number
param.number	Number		value to set number reducer to
param.meta	Object	optional	additional meta fields

Return:

{payload: Number, meta: {reducerName: String}, type: String}

Throw:

Error

Action payload must be of type Number

public setObjectAction(param: Object): {payload: String, meta: {reducerName: String}, type: String} source

import {setObjectAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/object/object.actions.js'

action creator to set object

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to set object
param.payload	Object		value to set reducer to
param.meta	Object	optional	additional meta fields

Return:

{payload: String, meta: {reducerName: String}, type: String}

Throw:

Error

Action payload must be of type String

public setStringAction(param: Object): {payload: String, meta: {reducerName: String}, type: String} source

import {setStringAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/string/string.actions.js'

action creator to set string

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to set string
param.string	String		value to set reducer to
param.meta	Object	optional	additional meta fields

Return:

{payload: String, meta: {reducerName: String}, type: String}

Throw:

Error

Action payload must be of type String

public toggleBooleanAction(param: Object): {meta: {reducerName: String}, type: String} source

import {toggleBooleanAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/boolean/boolean.actions.js'

action creator to toggle boolean

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to toggle boolean
param.meta	Object	optional	additional meta fields

Return:

{meta: {reducerName: String}, type: String}

public updateItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {updateItemAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to update item

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to update item
param.item	Object		item to update
param.index	Number		index to update item at
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public updateItemByKeyAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {updateItemByKeyAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to update item by key

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to update item by key
param.item	Object		item to update
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public updateItemsByKeyAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {updateItemsByKeyAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to update items by key

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to update items by key
param.items	Array		items to update
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

public updateObjectAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {updateObjectAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/object/object.actions.js'

action creator to update object

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to update object
param.payload	Object		key/value pair(s) to update with
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}

Throw:

Error

Action payload must be of type Object

public updateValueAllItemsAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

import {updateValueAllItemsAction} from '@wecreatesoftware/redux-higher-order-reducers/src/wecreate/software/list/list.actions.js'

action creator to update a value in all items in the reducer

Params:

Name	Type	Attribute	Description
param	Object		this is object param
param.reducerName	String		reducer name to update a value in all items
param.keyValuePairs	Array		key/value pair to update on all items
param.meta	Object	optional	additional meta fields

Return:

{payload: Object, meta: {reducerName: String}, type: string}