Returns a reducer that normalizes data based on the [normalizr] schemas provided. When an action is fired, if the type matches one provied in schemaMap the payload is normalized based off the given schema.\nTakes a map of schemas where each key is an action name and value is a schema. must have at least one key called mainSchema returns a reducer that holds the main entity state.
import {createEntityReducer} from 'redux-blueflag';\nimport EntitySchema from 'myapp/EntitySchema';\n\nexport default combineReducers({\n entity: createEntityReducer({\n GRAPHQL_RECEIVE: EntitySchema,\n MY_CUSTOM_ACTION_RECEIVE: EntitySchema.myCustomActionSceham\n }),\n});\nfunctionLocalStateHock(reducer: function(state, action)) => function(component: Component)\nWraps a component with a tiny implementation of the redux concept. Takes a reducer and returns a function ready to call with a component. The hock gives the component props.localDispatchwhich triggers the reducer. the return state of the reducer is then destructured on to the components as props.
functionPropChangeHock(propKeys: [String], sideEffect: function) => (component: Component) => Component\nThe prop change hock takes a side effect and an array of prop keys paths.\nThe component then listens for component mount and receive props.\nIf any of the provided props change the side effect is triggered.
\nreducerKeeps fetching and error state in a global redux property "async", which is an immutable.js Map\nIt tracks state on actions ending with _FETCH, _ERROR or _RECEIVE\nVariables are uppercase snakes and match the consts for fetch and error\nXXX_FETCH is a boolean indicating if that action is currently requesting info (or undefined before any actions have been dispatched)\nXXX_ERROR is either { status, message } if an error has occured, or is null otherwise\n^ really only useful for ensuring that a complete list of objects has been received when using ordered maps for collections. You won't know whether your list is complete or partial without this\ne.g. state.async.LEARNING_PLAN_FETCH
\nThis listens to all actions and tracks the fetching and error states of all in a generic way. Async state data is kept under the async key in redux.\nFetching state is kept in state.async.<FETCH_ACTION> and will either be true if the action is currently fetching or a falsey value otherwise. <FETCH_ACTION> refers to the name (string) of the fetch action, such as USER_GET_FETCH.\nError state is kept in state.async.<ERROR_ACTION> and will either be an error like {status: <status code>, message: <message>}, or null otherwise. <ERROR_ACTION> refers to the name (string) of the error action, such as USER_GET_ERROR.\nActions follow a strict naming convention, each ending in either _FETCH, _RECEIVE or _ERROR. This allows the AsyncStateReducer to listen to the various actions and keep track of async state.
functionTakes an action creator and gives it a resultKey. wraps it in PropChangeHock, entitySelect and requestStateSelect
Given the return value of creatRequestActionSet it will log the names of the created action types and creators
\narrayreturns a redux-thunk action creator that will dispatch the three states of our request action.\ndispatch fetchAction\ncall sideEffect\nthen dispatch recieveAction\ncatch dispatch errorAction
objectThe primary means of accessing entity state. Given a requestKey it will return the denormalized state object.
\nobjectGiven a path to entity state it will return the denormalized state.\nThis function is only used when you are certain you need the exact id in entity state.\nMost often the request key is more appropriate.
\nobjectReturns the state of a current request. Either fetching, error or not yet requested.
\nobject | Map of schema action names. |\n| constructor | function | constructor function to edit payload data before it is normalized. |\n\n\n\n## LocalStateHock ⇒ function\n`LocalStateHock(reducer: function(state, action)) => function(component: Component)`\nWraps a component with a tiny implementation of the redux concept. Takes a reducer and returns a function ready to call with a component. The hock gives the component `props.localDispatch`which triggers the reducer. the return state of the reducer is then destructured on to the components as props.\n\n**Returns**: function - componentCreator function to pass react component \n\n| Param | Type | Description |\n| --- | --- | --- |\n| reducer | function | a function that acts as a local reducer |\n\n\n\n## PropChangeHock ⇒ function\n```js\nPropChangeHock(propKeys: [String], sideEffect: function) => (component: Component) => Component\n```\nThe prop change hock takes a side effect and an array of prop keys paths.\nThe component then listens for component mount and receive props.\nIf any of the provided props change the side effect is triggered.\n\n**Returns**: function - componentCreator function to pass react component \n\n| Param | Type | Description |\n| --- | --- | --- |\n| propKeys | Array | list of strings of prop keys |\n| outputFunction | function | |\n\n\n\n## RequestStateReducer : reducer\nKeeps fetching and error state in a global redux property \"async\", which is an immutable.js Map\nIt tracks state on actions ending with _FETCH, _ERROR or _RECEIVE\nVariables are uppercase snakes and match the consts for fetch and error\nXXX_FETCH is a boolean indicating if that action is currently requesting info (or undefined before any actions have been dispatched)\nXXX_ERROR is either { status, message } if an error has occured, or is null otherwise\n^ really only useful for ensuring that a complete list of objects has been received when using ordered maps for collections. You won't know whether your list is complete or partial without this\ne.g. state.async.LEARNING_PLAN_FETCH\n\nThis listens to all actions and tracks the fetching and error states of all in a generic way. Async state data is kept under the `async` key in redux.\nFetching state is kept in `state.async.function\nTakes an action creator and gives it a `resultKey`. wraps it in PropChangeHock, entitySelect and requestStateSelect\n\n**Kind**: global function \n**Returns**: function - action creator \n\n| Param | Type |\n| --- | --- |\n| sideEffect | function | \n\n\n\n## logRequestActionNames(actionMap, prefix)\nGiven the return value of creatRequestActionSet it will log the names of the created action types and creators\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| actionMap | object | map of actions |\n| prefix | string | String to prefix actions types with |\n\n\n\n## createRequestActionSet(actionMap) ⇒ array\nreturns a [redux-thunk](thunk) action creator that will dispatch the three states of our request action.\ndispatch `fetchAction`\ncall `sideEffect`\nthen dispatch `recieveAction`\ncatch dispatch `errorAction`\n\n**Kind**: global function \n**Returns**: array - list of action creators and action types \n\n| Param | Type | Description |\n| --- | --- | --- |\n| actionMap | object | deep object representation of api functions |\n\n\n\n## selectEntity(state, resultKey, [schemaKey]) ⇒ object\nThe primary means of accessing entity state. Given a requestKey it will return the denormalized state object.\n\n**Kind**: global function \n**Returns**: object - entity map \n\n| Param | Type | Default |\n| --- | --- | --- |\n| state | object | | \n| resultKey | string | | \n| [schemaKey] | string | "mainSchema" | \n\n\n\n## selectEntityByPath(state, path, [schemaKey]) ⇒ object\nGiven a path to entity state it will return the denormalized state.\nThis function is only used when you are certain you need the exact id in entity state.\nMost often the request key is more appropriate.\n\n**Kind**: global function \n**Returns**: object - entity map \n\n| Param | Type | Default |\n| --- | --- | --- |\n| state | object | | \n| path | array | | \n| [schemaKey] | string | "mainSchema" | \n\n\n\n## selectRequestState(state, actions) ⇒ object\nReturns the state of a current request. Either fetching, error or not yet requested.\n\n**Kind**: global function \n**Returns**: object - the curerent request state \n\n| Param | Type | Description |\n| --- | --- | --- |\n| state | object | the current state |\n| actions | string | array | either one or many partial action types |\n\n\n","maintainers":[{"name":"allanhortle","email":"allanhortle@gmail.com"},{"name":"dancoates","email":"mail@dancoat.es"},{"name":"dxinteractive","email":"dxinteractive@gmail.com"}],"time":{"modified":"2022-06-26T10:00:50.050Z","created":"2016-08-29T04:28:08.434Z","0.1.1":"2016-08-29T04:28:08.434Z","0.1.2":"2016-08-29T04:52:56.131Z","0.2.0":"2016-09-01T06:36:14.072Z","0.2.1":"2016-09-01T06:36:49.085Z","0.3.0":"2016-09-04T23:01:04.450Z","0.4.0":"2016-09-05T00:42:42.697Z","0.4.1":"2016-09-05T01:04:43.233Z","0.5.0":"2016-09-05T02:28:12.753Z","0.5.1":"2016-09-05T03:17:48.898Z","0.5.2":"2016-09-05T04:32:11.591Z","0.6.0":"2016-09-12T06:27:22.558Z","0.7.0":"2016-09-14T02:33:11.410Z","0.7.1":"2016-09-14T02:55:44.816Z","0.7.2":"2016-09-14T02:59:40.223Z","0.7.3":"2016-09-14T03:07:29.607Z","0.7.4":"2016-09-19T00:52:20.729Z","0.7.5":"2016-09-19T03:28:34.086Z","0.7.6":"2016-09-20T00:47:39.196Z","0.8.0":"2016-09-20T04:22:13.094Z","0.8.1":"2016-10-04T00:00:27.241Z","0.9.0":"2016-10-14T03:33:04.036Z","0.9.1":"2016-10-25T05:55:02.924Z","0.10.0":"2016-11-01T23:56:22.726Z","0.10.1":"2016-11-02T04:53:21.436Z","0.11.0":"2016-11-08T04:58:33.744Z","0.11.1":"2016-11-09T00:10:10.291Z","0.11.2":"2016-11-09T00:15:17.610Z","0.11.3":"2016-11-10T01:08:09.174Z","0.12.0":"2016-11-10T03:16:14.298Z","0.13.0":"2016-11-11T03:31:27.160Z","0.13.1":"2016-11-11T03:32:51.671Z","0.13.2":"2016-11-14T05:17:50.137Z","0.13.3":"2016-11-24T23:37:08.393Z","0.14.0":"2016-11-29T01:10:54.744Z","0.15.0":"2016-12-09T01:35:31.169Z","0.15.1":"2016-12-09T05:50:15.901Z","0.15.2":"2016-12-12T05:48:00.476Z","0.16.0":"2016-12-22T06:40:51.830Z","0.17.0":"2016-12-22T23:06:17.446Z","0.18.0":"2016-12-23T04:36:23.421Z","0.18.1":"2017-01-30T05:45:51.392Z"},"homepage":"https://github.com/blueflag/redux-blueflag#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/blueflag/redux-blueflag.git"},"bugs":{"url":"https://github.com/blueflag/redux-blueflag/issues"},"license":"ISC","readmeFilename":"README.md"}