reducers.members.md

reducers.members

Reducer for the Redux store segment that holds members data.

Todo

• Document state segment structure.

• reducers.members
  • static
    • .default
    • .factory() ⇒ Promise
  • inner
    • ~onDrop(state, action) ⇒ Object
    • ~onDropAll() ⇒ Object
    • ~onGetAchievementsInit(state) ⇒ Object
    • ~onGetAchievementsDone(state, error) ⇒ Object
    • ~onGetAchievementsV3Done(state, error) ⇒ Object
    • ~onGetFinancesInit(state) ⇒ Object
    • ~onGetFinancesDone(state, action) ⇒ Object
    • ~onGetStatsInit(state, action) ⇒ Object
    • ~onGetStatsDone(state, action) ⇒ Object
    • ~onGetStatsHistoryInit(state, action) ⇒ Object
    • ~onGetStatsHistoryDone(state, action) ⇒ Object
    • ~onGetStatsDistributionInit(state, action) ⇒ Object
    • ~onGetStatsDistributionDone(state, action) ⇒ Object
    • ~onGetActiveChallengesInit(state, action) ⇒ Object
    • ~onGetActiveChallengesDone(state, action) ⇒ Object
    • ~create(initialState) ⇒ function

reducers.members.default

Reducer with default initial state.

Kind: static property of reducers.members

reducers.members.factory() ⇒ Promise

Factory which creates a new reducer with its initial state tailored to the given options object, if specified (for server-side rendering). If options object is not specified, it creates just the default reducer. Accepted options are:

Kind: static method of reducers.members
Resolves: Function(state, action): state New reducer.

reducers.members~onDrop(state, action) ⇒ Object

Drops information about a member.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onDropAll() ⇒ Object

Drops all loaded information on members.

Kind: inner method of reducers.members
Returns: Object - New state.

reducers.members~onGetAchievementsInit(state) ⇒ Object

Inits the loading of member achievements.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action.handle	String
action.uuid	String

reducers.members~onGetAchievementsDone(state, error) ⇒ Object

Finalizes the loading of member achievements from v2 API.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
error	Object
payload.data	Array
payload.handle	String
payload.uuid	String

reducers.members~onGetAchievementsV3Done(state, error) ⇒ Object

Finalizes the loading of member achievements from v3 API.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
error	Object
payload.data	Array
payload.handle	String
payload.uuid	String

reducers.members~onGetFinancesInit(state) ⇒ Object

Initializes the loading of member financial information.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action.payload.handle	String
action.payload.uuid	String

reducers.members~onGetFinancesDone(state, action) ⇒ Object

Finalizes a pending loading of member financial information.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetStatsInit(state, action) ⇒ Object

Inits the loading of member stats.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetStatsDone(state, action) ⇒ Object

Finalizes the loading of member stats.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetStatsHistoryInit(state, action) ⇒ Object

Inits the loading of member stats history.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetStatsHistoryDone(state, action) ⇒ Object

Finalizes the loading of member stats history.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetStatsDistributionInit(state, action) ⇒ Object

Inits the loading of member stats distribution.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetStatsDistributionDone(state, action) ⇒ Object

Finalizes the loading of member stats distribution.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetActiveChallengesInit(state, action) ⇒ Object

Inits the loading of member active challenges.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~onGetActiveChallengesDone(state, action) ⇒ Object

Finalizes the loading of member active challenges.

Kind: inner method of reducers.members
Returns: Object - New state.

Param	Type
state	Object
action	Object

reducers.members~create(initialState) ⇒ function

Creates a new Members reducer with the specified initial state.

Kind: inner method of reducers.members
Returns: function - Members reducer.

Param	Type	Description
initialState	Object	Optional. Initial state.