abort-error - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

dist/index.min.js

 (function (root, factory) {(typeof module === 'object' && module.exports) ? module.exports = factory() : root.AbortError = factory()}(typeof self !== 'undefined' ? self : this, function () {
-"use strict";var AbortError=(()=>{var o=Object.defineProperty;var c=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var E=(e,r)=>{for(var a in r)o(e,a,{get:r[a],enumerable:!0})},b=(e,r,a,n)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of m(r))!x.call(e,t)&&t!==a&&o(e,t,{get:()=>r[t],enumerable:!(n=c(r,t))||n.enumerable});return e};var d=e=>b(o({},"__esModule",{value:!0}),e);var i={};E(i,{AbortError:()=>s});var s=class extends Error{static name="AbortError";name="AbortError"};return d(i);})();
+"use strict";var AbortError=(()=>{var a=Object.defineProperty;var c=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var b=Object.prototype.hasOwnProperty;var d=(e,r)=>{for(var o in r)a(e,o,{get:r[o],enumerable:!0})},i=(e,r,o,n)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of p(r))!b.call(e,t)&&t!==o&&a(e,t,{get:()=>r[t],enumerable:!(n=c(r,t))||n.enumerable});return e};var m=e=>i(a({},"__esModule",{value:!0}),e);var u={};d(u,{AbortError:()=>s});var s=class extends Error{static name="AbortError";name="AbortError";constructor(r="The operation was aborted",...o){super(r,...o)}};return m(u);})();
 return AbortError}));

dist/src/index.d.ts

@@ -7,5 +7,5 @@ /**
  *
- * @example
+ * @example Using `AbortError`
  *
- * ```TypeScript
+ * ```JavaScript
  * import { AbortError } from 'abort-error'
@@ -21,2 +21,14 @@ *
  * ```
+ *
+ * @example Using `AbortOptions`
+ *
+ * ```TypeScript
+ * import type { AbortOptions } from 'abort-error'
+ *
+ * async function myFunction (options?: AbortOptions) {
+ *   return fetch('https://example.com', {
+ *     signal: options?.signal
+ *   })
+ * }
+ * ```
  */
@@ -29,3 +41,4 @@ export interface AbortOptions {
     name: string;
+    constructor(message?: string, ...rest: any[]);
 }
 //# sourceMappingURL=index.d.ts.map

dist/src/index.js

@@ -7,5 +7,5 @@ /**
  *
- * @example
+ * @example Using `AbortError`
  *
- * ```TypeScript
+ * ```JavaScript
  * import { AbortError } from 'abort-error'
@@ -21,2 +21,14 @@ *
  * ```
+ *
+ * @example Using `AbortOptions`
+ *
+ * ```TypeScript
+ * import type { AbortOptions } from 'abort-error'
+ *
+ * async function myFunction (options?: AbortOptions) {
+ *   return fetch('https://example.com', {
+ *     signal: options?.signal
+ *   })
+ * }
+ * ```
  */
@@ -26,3 +38,6 @@ export class AbortError extends Error {
     name = 'AbortError';
+    constructor(message = 'The operation was aborted', ...rest) {
+        super(message, ...rest);
+    }
 }
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "abort-error",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "An error to be used by AbortSignal handlers",
@@ -16,3 +16,4 @@ "author": "Alex Potsides <[e-mail]>",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
@@ -132,3 +133,3 @@ "type": "module",
     "test:firefox": "aegir test -t browser -- --browser firefox",
-    "test:electron-main": "aegir test -f dist/test/node.js -t electron-main",
+    "test:electron-main": "aegir test -t electron-main",
     "build": "aegir build",
@@ -135,0 +136,0 @@ "release": "aegir release",

README.md

@@ -1,3 +0,1 @@
-# mortice
-
 # abort-error
@@ -30,5 +28,5 @@
 
-## Example
+## Example - Using `AbortError`
 
-```TypeScript
+```JavaScript
 import { AbortError } from 'abort-error'
@@ -45,2 +43,14 @@
 
+## Example - Using `AbortOptions`
+
+```TypeScript
+import type { AbortOptions } from 'abort-error'
+
+async function myFunction (options?: AbortOptions) {
+  return fetch('https://example.com', {
+    signal: options?.signal
+  })
+}
+```
+
 # Install
@@ -47,0 +57,0 @@

src/index.ts

@@ -7,5 +7,5 @@ /**
  *
- * @example
+ * @example Using `AbortError`
  *
- * ```TypeScript
+ * ```JavaScript
  * import { AbortError } from 'abort-error'
@@ -21,2 +21,14 @@ *
  * ```
+ *
+ * @example Using `AbortOptions`
+ *
+ * ```TypeScript
+ * import type { AbortOptions } from 'abort-error'
+ *
+ * async function myFunction (options?: AbortOptions) {
+ *   return fetch('https://example.com', {
+ *     signal: options?.signal
+ *   })
+ * }
+ * ```
  */
@@ -31,2 +43,6 @@
   name = 'AbortError'
+
+  constructor (message: string = 'The operation was aborted', ...rest: any[]) {
+    super(message, ...rest)
+  }
 }

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10723

increased by22.16%

Number of package files

10

increased by11.11%

Lines of code

131

increased by57.83%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

82

increased by13.89%

No dependency changes