API Store

.babelrc

@@ -0,0 +1,16 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react"],
+  "ignore": [
+    "src/helpers/**",
+    "src/pages/**",
+    "src/utils/testing/**",
+    "src/routes/**",
+    "src/store/*.js",
+    "src/App.js",
+    "src/App.test.js",
+    "src/index.js",
+    "src/initialize.js",
+    "src/setupTests.js",
+    "src/*.css"
+  ]
+}

.env

@@ -0,0 +1,3 @@
+REACT_APP_API_RETRY_TIMEOUT=1500
+REACT_APP_API_RETRY_COUNT=10
+REACT_APP_API_DEFAULT_MAX_AGE=60000

.env.test

@@ -0,0 +1,3 @@
+REACT_APP_API_RETRY_TIMEOUT=10
+REACT_APP_API_RETRY_COUNT=10
+REACT_APP_API_DEFAULT_MAX_AGE=60000

.npmignore

@@ -1,7 +1,7 @@
 
 /public
 /src/helpers
-/src/utils
+/src/utils/testing
 /src/App.js
 /src/App.test.js
 /src/App.css

README.md

@@ -32,8 +32,10 @@ In the `sagas.js` file:
 ```js
 import { apiSaga, initializeAPIStore } from "api-calls-store/src/package-index";
 
+const clockCount = 15;
 initializeAPIStore({
   getAPI,
+  clockCount, // clockCount is the amount of times an API_CALL will be skipped - default is 10
 });
 
 export default function* rootSaga() {
@@ -44,31 +46,60 @@ export default function* rootSaga() {
 }
 ```
 
+### Add the dispatch clock
+
+In the `App.js` add this `useEffect` to dispatch the clock every Xms.
+This clock will dispatch an action in the saga every Xms and that action will call the API.
+
+```js
+useEffect(() => {
+  const interval = setInterval(() => {
+    dispatch({ type: "API_DISPATCH_CLOCK" });
+  }, 1000);
+  return () => clearInterval(interval);
+}, [dispatch]);
+```
+
 # Actions
 
 ```js
-/* API */
+/**
+ * {type: API_CALL, apiName: "apy", args: [], method: method || "GET" }
+ */
 export const API_CALL = "API_CALL";
-export const API_CALL_SUCCESS = "API_CALL_SUCCESS";
-export const API_CALL_FAIL = "API_CALL_FAIL";
 
-/*
- * Sample actions
- * {type: API_CALL, apiName: "apy", args: [], method: method || "GET" }
+/**
  * {type: API_CALL_SUCCESS, call_key: "0x...", value: 221, code: 200, timestamp: new Date().getTime() }
+ */
+export const API_CALL_SUCCESS = "API_CALL_SUCCESS";
+
+/**
  * {type: API_CALL_FAIL, call_key: "0x...", value: 221, code: 200, timestamp: new Date().getTime() }
  */
+export const API_CALL_FAIL = "API_CALL_FAIL";
 
+/**
+ * {type: API_ADD_SUBSCRIPTION, key: "positions", componentApiCalls: [{ apiName: "apy", args: [etkAddress] }] }
+ */
 export const API_ADD_SUBSCRIPTION = "API_ADD_SUBSCRIPTION";
-export const API_REMOVE_SUBSCRIPTION = "API_REMOVE_SUBSCRIPTION";
 
-/*
- * Sample actions
- * {type: API_ADD_SUBSCRIPTION, key: "positions", componentApiCalls: [{ apiName: "apy", args: [etkAddress] }] }
+/**
  * {type: API_REMOVE_SUBSCRIPTION, key: "positions" }
  */
+export const API_REMOVE_SUBSCRIPTION = "API_REMOVE_SUBSCRIPTION";
 
+/**
+ * API_DISPATCH_CLOCK -> This clock will dispatch an action in the saga every Xms and that action will call the API.
+ */
 export const API_DISPATCH_CLOCK = "API_DISPATCH_CLOCK";
-export const API_SET_NEXT_CLOCK = "API_SET_NEXT_CLOCK";
-export const API_INCREASE_COUNT = "API_INCREASE_COUNT";
+
+/**
+ * API_SUBSCRIPTION_INCREASE_CLOCK -> This action sets when to call each subscription again
+ */
+export const API_SUBSCRIPTION_INCREASE_CLOCK = "API_SUBSCRIPTION_INCREASE_CLOCK";
+
+/**
+ * API_INCREASE_CLOCK -> Increase the general clock to check if the saga should call the API again
+ */
+export const API_INCREASE_CLOCK = "API_INCREASE_CLOCK";
 ```