Home Reference Source Test

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

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

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

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

action creator to add item to end of list

Params:

NameTypeAttributeDescription
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

action creator to add items to end of list

Params:

NameTypeAttributeDescription
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 insertItemAction(param: Object): {payload: Object, meta: {reducerName: String}, type: string} source

action creator to insert item

Params:

NameTypeAttributeDescription
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

action creator to remove item

Params:

NameTypeAttributeDescription
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

action creator to remove item by key

Params:

NameTypeAttributeDescription
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

action creator to reset boolean to original state

Params:

NameTypeAttributeDescription
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

action creator to reset list

Params:

NameTypeAttributeDescription
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 resetObjectAction(param: Object): {meta: {reducerName: String}, type: String} source

action creator to reset object to original state

Params:

NameTypeAttributeDescription
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

action creator to reset string to original state

Params:

NameTypeAttributeDescription
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

action creator to set boolean

Params:

NameTypeAttributeDescription
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

action creator to set list

Params:

NameTypeAttributeDescription
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 setObjectAction(param: Object): {payload: String, meta: {reducerName: String}, type: String} source

action creator to set object

Params:

NameTypeAttributeDescription
param Object

this is object param

param.reducerName String

reducer name to set object

param.payload 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 setStringAction(param: Object): {payload: String, meta: {reducerName: String}, type: String} source

action creator to set string

Params:

NameTypeAttributeDescription
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

action creator to toggle boolean

Params:

NameTypeAttributeDescription
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

action creator to update item

Params:

NameTypeAttributeDescription
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

action creator to update item by key

Params:

NameTypeAttributeDescription
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

action creator to update items by key

Params:

NameTypeAttributeDescription
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

action creator to update object

Params:

NameTypeAttributeDescription
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

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

Params:

NameTypeAttributeDescription
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}