Members
(constant) ACTIONS_PREFIX_BASE
Prefix for every Redux action defined by the Olaf Framework.
(constant) FETCH_ERROR_ACTION
- Description:
Redux action dispatched when fetch call finishes with/because of errors.
- Source:
Redux action dispatched when fetch call finishes with/because of errors.
(constant) FETCH_STARTED_ACTION
- Description:
Redux action dispatched for every fetch call.
- Source:
Redux action dispatched for every fetch call.
(constant) FETCH_STATUS
- Description:
Constants for fetch status tracking.
- Source:
Constants for fetch status tracking.
(constant) FETCH_SUCCESS_ACTION
- Description:
Redux action dispatched when fetch call finishes without errors.
- Source:
Redux action dispatched when fetch call finishes without errors.
(constant) PUBLIC_SET_APP_INFO
- Description:
Action for setting application info
- Source:
Action for setting application info
(constant) TAGS
- Description:
Constants used to tag component related logs, fetch requests statuses, etc ...
- Source:
Constants used to tag component related logs, fetch requests statuses, etc ...
(constant) UTILS_ACTIONS_PREFIX
Prefix for utility Redux actions.
(constant) getAppName
- Description:
Selector returnig app name defined on app initialisation. Check Application.
- Source:
Selector returnig app name defined on app initialisation. Check Application.
(constant) getData
- Description:
Selector returning status for the specific fetch call.
- Source:
Selector returning status for the specific fetch call.
(constant) getFetchError
- Description:
Selector returning error (if any) for the specific fetch call differentiated by tag.
- Source:
Selector returning error (if any) for the specific fetch call differentiated by tag.
(constant) getFetchInProgress
- Description:
Selector returning is fetchig in progress for the specific fetch call differentiated by tag.
- Source:
Selector returning is fetchig in progress for the specific fetch call differentiated by tag.
(constant) getFetchStatus
- Description:
Selector returning status for the specific fetch call differentiated by tag.
- Source:
Selector returning status for the specific fetch call differentiated by tag.
(constant) initialState
- Description:
Initial global state.
- Source:
Initial global state.
Methods
Application(props)
- Description:
Main application component
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
props |
any |
checkStatus(response) → {object|undefined}
- Description:
Checks if a network request came back fine, and throws an error if not
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
response |
object | A response from a network request |
Returns:
Returns either the response, or throws an error
- Type
- object | undefined
createSagaInjector(runSaga)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
runSaga |
runSaga is middleware.run function |
Returns:
a function that can be used to inject sagas dynamically
(async, generator) defaultSaga() → {void}
- Description:
Default saga
- Source:
Returns:
- Type
- void
(async) fetch(url, options, tag) → {void}
- Description:
fetch
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
url |
string | |
options |
object | |
tag |
string |
Returns:
- Type
- void
(async, generator) init(action) → {void}
- Description:
fetch
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
action |
object |
Returns:
- Type
- void
parseJSON(response) → {object}
- Description:
Parses the JSON returned by a network request
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
response |
object | A response from a network request |
Returns:
The parsed JSON from the request
- Type
- object
(async, generator) rootSaga() → {void}
- Description:
Root saga
- Source:
Returns:
- Type
- void
setAppInfoAction()
- Description:
Action creator. Dispatches PUBLIC_SET_APP_INFO.
- Source: