Preparing for npm

Author: marcveens

.prettierrc

@@ -1,44 +1,35 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# react-context-mutex
+A mutex implementation using React and React context. It will prevent a function from running multiple times, until you allow it to run again. 
 
-## Available Scripts
+I created this because I wanted to prevent a fetch from running multiple times after implementing a custom hook in multiple components. The custom hook had a `useEffect` which ran the fetch function.
 
-In the project directory, you can run:
+## How to use
+```ts
+const fetchData = () => {
+    const mutex = new Mutex('myUniqueKey1');
 
-### `npm start`
+    mutex.run(async () => {
+        mutex.lock();
+        try {
+            const response = await fetch('http://myurl');
+            const data = await response.json();
+            mutex.unlock();
+        } catch (e) {
+            mutex.unlock();
+        }
+    });
+};
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+fetchData();
+fetchData();
+fetchData();
+```
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+The fetchData function runs multiple times but the actual fetch is only done once. When the mutex is unlocked again, the fetch will also execute again.
 
-### `npm test`
+## How it works
+Behind the scenes there's an array of strings, representing the mutex keys, registered using React context. A new record is added to the array when a process should be locked. Likewise, the record is removed when the process is unlocked. 
 
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+When using the `mutex.run` method, there's a check to see if the process is locked or not. If it is, the callback within the `mutext.run` is abandoned. If the provided key does not reference to a locked process, the callback is executed. 
 
-### `npm run build`
-
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+Why React context? Because that way the "mutex store" array will only be initiated once, thus able to use throughout multiple components without causing unwanted collisions.

README.md

@@ -12,9 +12,9 @@
   "scripts": {
     "test": "jest",
     "build": "rollup -c",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json"
   },
+  "files": ["dist/**/*"],
   "repository": {
     "type": "git",
     "url": "https://github.com/marcveens/react-context-mutext.git"
@@ -29,13 +29,11 @@
     "@types/jest": "^24.9.0",
     "@types/node": "^12.12.25",
     "jest": "^24.9.0",
-    "prettier": "^1.19.1",
     "rollup": "^1.29.0",
     "rollup-plugin-typescript2": "^0.25.3",
     "ts-jest": "^24.3.0",
     "tslib": "^1.10.0",
     "tslint": "^5.20.1",
-    "tslint-config-prettier": "^1.18.0",
     "typescript": "^3.7.5"
   }
 }

package-lock.json

@@ -1,7 +1,4 @@
 {
-    "extends": [
-        "tslint-config-prettier"
-    ],
     "rules": {
         "semicolon": [
             true,