Renamed requestsReducer getDefault to getDefaultData and added it to …

…types and docs
klis87 · Feb 28, 2019 · db88e1d · db88e1d
1 parent 5b75c61
commit db88e1d
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 13 deletions.
diff --git a/packages/redux-saga-requests/README.md b/packages/redux-saga-requests/README.md
@@ -451,6 +451,9 @@ In order to be flexible, apart from `actionType` passed in `requestsReducer` con
 following attributes:
 - `multiple: boolean`: default to `false`, change it to `true` if you want your not loaded data to be stored as `[]`
 instead of `null`
+- `getDefaultData: (multiple: boolean) => any`: use instead of `multiple`, if you want your initial data to be
+something else than `null` or `[]`, for instance `() => ({ value: null })`, `multiple => (multiple ? [] : null)`
+by default
 - `getData: (state, action, config) => data`: describes how to get data from `action` object, by default returns `action.data` or `action.payload.data` when action is FSA compliant
 - `updateData: (state, action, config) => data`: optional, useful together with operations to overwrite `getData` default, see more
 information in `operations`

diff --git a/packages/redux-saga-requests/src/reducers.js b/packages/redux-saga-requests/src/reducers.js
@@ -15,8 +15,8 @@ const normalizeActionType = actionType =>
 const operationConfigHasRequestKey = config =>
   typeof config !== 'boolean' && !!config.getRequestKey;
 
-const getInitialRequestState = ({ getDefault, multiple, operations }) => ({
-  data: getDefault(multiple),
+const getInitialRequestState = ({ getDefaultData, multiple, operations }) => ({
+  data: getDefaultData(multiple),
   pending: 0,
   error: null,
   operations:
@@ -59,7 +59,7 @@ const getDataUpdaterForSuccess = (reducerConfig, operationConfig) => {
 
 const defaultConfig = {
   multiple: false,
-  getDefault: (multiple) => multiple ? [] : null,
+  getDefaultData: multiple => (multiple ? [] : null),
   getData: (state, action) =>
     action.payload ? action.payload.data : action.data,
   updateData: null,
@@ -77,7 +77,7 @@ const defaultConfig = {
   }),
   onError: (state, action, config) => ({
     ...state,
-    data: config.getDefault(config.multiple),
+    data: config.getDefaultData(config.multiple),
     pending: state.pending - 1,
     error: config.getError(state, action, config),
   }),

diff --git a/packages/redux-saga-requests/src/reducers.spec.js b/packages/redux-saga-requests/src/reducers.spec.js
@@ -84,9 +84,15 @@ describe('reducers', () => {
     });
 
     describe('providing the default value of the reducer', () => {
-      const emptyFeatureCollection = { type: 'FeatureCollection', features: [] };
-      const defaultProvider = jest.fn(() => (emptyFeatureCollection));
-      const reducer = requestsReducer({ actionType, getDefault: defaultProvider });
+      const emptyFeatureCollection = {
+        type: 'FeatureCollection',
+        features: [],
+      };
+      const defaultProvider = jest.fn(() => emptyFeatureCollection);
+      const reducer = requestsReducer({
+        actionType,
+        getDefaultData: defaultProvider,
+      });
 
       afterEach(() => {
         defaultProvider.mockClear();
@@ -105,12 +111,17 @@ describe('reducers', () => {
       it('resets data via getDefault on errors', () => {
         const someError = 'asdasda';
         const action = { type: error(actionType), error: someError };
-        expect(reducer({
-          data: {},
-          error: someError,
-          pending: 1,
-          operations: null,
-        }, action)).toEqual({
+        expect(
+          reducer(
+            {
+              data: {},
+              error: someError,
+              pending: 1,
+              operations: null,
+            },
+            action,
+          ),
+        ).toEqual({
           data: emptyFeatureCollection,
           error: someError,
           pending: 0,

diff --git a/packages/redux-saga-requests/types/index.d.spec.ts b/packages/redux-saga-requests/types/index.d.spec.ts
@@ -84,6 +84,7 @@ watchRequests({ abortOn: ['TYPE'] });
 
 const globalConfig = {
   multiple: false,
+  getDefaultData: multiple => (multiple ? [] : null),
   getData: (state, action) => action.payload.data,
   getError: (state, action) => action.payload,
   onRequest: (state, action, { multiple }) => ({

diff --git a/packages/redux-saga-requests/types/index.d.ts b/packages/redux-saga-requests/types/index.d.ts
@@ -104,6 +104,7 @@ type Operations = {
 
 type GlobalReducerConfig = {
   multiple?: boolean;
+  getDefaultData?: (multiple: boolean) => any;
   getData?: OnActionCallback;
   updateData?: OnActionCallback;
   getError?: OnActionCallback;
@@ -124,6 +125,7 @@ type LocalReducerConfig = GlobalReducerConfig & ActionTypeReducerConfig;
 type MergedReducerConfig = {
   actionType: string;
   multiple: boolean;
+  getDefaultData: (multiple: boolean) => any;
   getData: OnActionCallback;
   updateData?: OnActionCallback;
   getError: OnActionCallback;