abortjs - npm Package Compare versions

Comparing version 0.0.1-beta to 0.0.1

package.json

 {
   "name": "abortjs",
-  "version": "0.0.1-beta",
+  "version": "0.0.1",
   "scripts": {
@@ -12,19 +12,26 @@ "test": "cd tests/package-tests && npm i && cd ../.. && npx jest --watchAll",
     "lint": "npx eslint src",
-    "lint:fix": "npx eslint src --fix"
-  },  
+    "lint:fix": "npx eslint src --fix",
+    "publish": "git add . && git commit -m 'Publish package' && git push && npm run build && npm publish",
+    "v:patch": "npm version patch",
+    "v:minor": "npm version minor",
+    "v:major": "npm version mayor"
+  },
   "main": "dist/cjs/index.js",
-	"module": "dist/esm/index.js",
-	"types": "dist/types/index.d.ts",
-	"exports": {
-		".": {
-			"require": "./dist/cjs/index.js",
-			"import": "./dist/esm/index.js"
-		}
-	},  
-	"author": "brdevok",
-	"description": "Small implementation of AbortController API for easy management of requests cancelation.",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "author": "brdevok",
+  "description": "Small implementation of AbortController API for easy management of requests cancelation.",
   "license": "MIT",
   "keywords": [
-		"abort", "fetch", "browser", "signal"
-	],
+    "abort",
+    "fetch",
+    "browser",
+    "signal"
+  ],
   "devDependencies": {
@@ -31,0 +38,0 @@ "@types/jest": "^28.1.2",

README.md

@@ -5,4 +5,15 @@ # AbortJs :scissors:
 
-## Quick start with `watch()` method
+ * [What it does](#what-it-does)
+ * [Quick start](#quick-start)
+ * [Aborting multiple requests](#aborting-multiple-requests)
+ * [Events](#events)
+ * [Current event names](#current-event-names)
+ * [Complete API](#complete-api)
 
+## What it does?
+
+AbortJs was created to facilitate the use of abort controllers in your code, it provides to the user a set of tools with a clean interface to easily manage the cancelation of requests withot relying in additional lines of code but with quick integration.
+
+## Quick start
+
 Import the package where you need it.
@@ -20,8 +31,7 @@
 
-Then make use of the `watch()` method for automatic cancelation of the request on re-calls.
+Then you can make use of the `watch()` method to start working with requests and abort controllers at once.
 
-The `watch` method requires a unique string name and a callback containing your fetch, the string will be used to as an identifier of the `AbortController` created for the callback, you can access the `signal` of that controller from the callback parameter.
+The `watch` method requires two arguments, the first is a string that will be used as an identifier and give a name to the controller that is going to be created, the second is a callback containing the signal of the created controller as an argument.
+You can write your requests inside of the callback and pass the signal, then every time your code repeats the sequence, the controller related to that signal will be aborted before running the callback again.
 
-If you repeat the controller name in another part of your code, you may be leading to unwanted cancelations.
-
 ```javascript
@@ -31,5 +41,6 @@ Abort.watch('my-controller', (signal) => fetch('...', { signal: signal }));
 
-You can store the value of your fetch returning it from the callback.
+If needed, you can store the value of your fetchs returning it from the callback or using promises.
 
 ```javascript
+// Using promises
 const response = new Promise((resolve, reject) => {
@@ -47,28 +58,30 @@ Abort.watch('my-controller', (signal) => {
 ```javascript
+// Using async await)
 const response = await Abort.watch('my-controller', async (signal) => await fetch('...', { signal }));
 ```
 
-Now you fetchs will be aborted automatically every time your code repeats the sequence.
+Note that if you repeat the name of the controller (`'my-controller'` in this case), it may cause unwanted aborts in your code, make sure you are using unique strings values for every watch, unless you want to override the callback.
 
-## The `watchAll()` method
+## Aborting multiple requests
 
-If you want to make several requests and have control of all them, you can make use of the `watchAll()` method.
-It accepts an array of 2 items arrays, the first item is a controller unique name, and the second is a callback.
+If you want to make several requests and have control of all of them, you can make use of the `watchAll()` method.
+It accepts an array of two items arrays, these two items works exactly like the `watch()` method parameters just above, the first is a string with the controller name and the second a callback with the signal.
 
 ```javascript
 const responses = await Abort.watchAll([
-	['controller-1', (signal) => fetch('...', { signal })],
-	['controller-2', (signal) => fetch('...', { signal })],
-	['controller-3', (signal) => fetch('...', { signal })],
-	['controller-4', (signal) => fetch('...', { signal })],
+	['controller1', (signal) => fetch('...', { signal })],
+	['controller2', (signal) => fetch('...', { signal })],
+	['controller3', (signal) => fetch('...', { signal })],
+	['controller4', (signal) => fetch('...', { signal })],
 ]);
 ```
 
-The return is an object containing the results of each callback labeled by it's controller name.
+All callbacks will be executed in the same order they are placed.
+An object with the controller names will be returned, each name is a key and it's value corresponds to the result of the callback.
 
 ```javascript
-await responses['controller-1'] // results of ['controller-1', (signal) => fetch('...', { signal })]
-await responses['controller-2'] // results of ['controller-2', (signal) => fetch('...', { signal })]
-await responses['controller-3'] // results of ['controller-3', (signal) => fetch('...', { signal })]
-await responses['controller-4'] // results of ['controller-4', (signal) => fetch('...', { signal })]
+await responses.controller1 // results of ['controller-1', (signal) => fetch('...', { signal })]
+await responses.controller2 // results of ['controller-2', (signal) => fetch('...', { signal })]
+await responses.controller3 // results of ['controller-3', (signal) => fetch('...', { signal })]
+await responses.controller4 // results of ['controller-4', (signal) => fetch('...', { signal })]
 ```
@@ -78,6 +91,14 @@
 
-AbortJs has events that fires every time something related to a controller happens, [see how manage them](#on(event, callback)).
+AbortJs is equiped with a set of events that fires every time something related to a controller happens, to access these events you can make use of the `on()` method.
 
-Current event names:
+The `on(event, callback)` receives two arguments, the first is the event name that want to be listened, the second is a callback that will be executed when the event fires. Also the callback provides an object containing data of the controller that fired the event.
 
+```javascript
+Abort.on('create', (e) => console.log(e.controller));
+```
+
+Now every time a controller is created (i.e. calling `watch`, `watchAll`, or `create`), it will log the name of the controller.
+
+#### Current event names
+
  * `'create'` - Every time a controller is created.
@@ -84,0 +105,0 @@ * `'remove'` - Every time a controller is removed.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34508

increased by5.29%

Number of lines in readme file

164

increased by14.69%

No dependency changes