@azure/abort-controller 1.0.1 → 1.0.2

package/package.json

@@ -1,26 +1,26 @@
 {
   "name": "@azure/abort-controller",
   "sdk-type": "client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Microsoft Azure SDK for JavaScript - Aborter",
   "main": "./dist/index.js",
-  "module": "./dist-esm/src/aborter.js",
+  "module": "dist-esm/src/index.js",
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
     "build:es6": "tsc -p tsconfig.json",
     "build:nodebrowser": "rollup -c 2>&1",
     "build:test": "rollup -c rollup.test.config.js 2>&1",
     "build": "npm run build:es6 && npm run build:nodebrowser",
-    "check-format": "prettier --list-different --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
-    "clean": "rimraf dist dist-esm dist-test types temp browser/*.js* browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-esm dist-test types temp dist-browser/*.js* dist-browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
     "execute:samples": "echo skipped",
     "extract-api": "tsc -p . && api-extractor run --local",
-    "format": "prettier --write --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "integration-test:browser": "echo skipped",
     "integration-test:node": "echo skipped",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "lint:fix": "eslint \"src/**/*.ts\" \"test/**/*.ts\" -c ../../.eslintrc.json --fix --fix-type [problem,suggestion]",
-    "lint": "eslint -c ../../.eslintrc.json src test --ext .ts -f html -o abort-controller-lintReport.html || exit 0",
+    "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json src test --ext .ts",
     "pack": "npm pack 2>&1",
     "prebuild": "npm run clean",
     "pretest": "npm run build:test",
@@ -28,60 +28,62 @@
     "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
     "test": "npm run build:test && npm run unit-test && npm run integration-test",
     "unit-test:browser": "karma start --single-run",
-    "unit-test:node": "cross-env TS_NODE_FILES=true TS_NODE_COMPILER_OPTIONS=\"{\\\"module\\\": \\\"commonjs\\\"}\" mocha --require ts-node/register --require source-map-support/register --reporter mocha-multi --reporter-options spec=-,mocha-junit-reporter=- --full-trace --no-timeouts test/*.spec.ts",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+    "unit-test:node": "cross-env TS_NODE_FILES=true TS_NODE_COMPILER_OPTIONS=\"{\\\"module\\\": \\\"commonjs\\\"}\" mocha --require ts-node/register --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace --no-timeouts test/*.spec.ts",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "build:samples": "echo Skipped.",
+    "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --mode file --out ./dist/docs ./src"
   },
-  "types": "./types/src/aborter.d.ts",
+  "types": "./types/src/index.d.ts",
   "engine": {
     "node": ">=8.0.0"
   },
   "files": [
     "dist/",
     "dist-esm/src/",
-    "src/",
+    "shims-public.d.ts",
     "types/src",
-    "tsconfig.json"
+    "README.md",
+    "LICENSE"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Azure/azure-sdk-for-js.git"
+  "engines": {
+    "node": ">=8.0.0"
   },
+  "repository": "github:Azure/azure-sdk-for-js",
   "keywords": [
-    "Azure",
-    "Aborter",
-    "AbortSignal",
-    "Cancellation",
-    "Node.js",
-    "TypeScript",
-    "JavaScript",
-    "Browser"
+    "azure",
+    "aborter",
+    "abortsignal",
+    "cancellation",
+    "node.js",
+    "typescript",
+    "javascript",
+    "browser",
+    "cloud"
   ],
   "author": "Microsoft Corporation",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/Azure/azure-sdk-for-js/issues"
   },
-  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/abort-controller",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/abort-controller/README.md",
   "sideEffects": false,
   "dependencies": {
-    "tslib": "^1.9.3"
+    "tslib": "^2.0.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.5.4",
+    "@azure/eslint-plugin-azure-sdk": "^3.0.0",
+    "@microsoft/api-extractor": "7.7.11",
+    "@rollup/plugin-commonjs": "11.0.2",
+    "@rollup/plugin-multi-entry": "^3.0.0",
+    "@rollup/plugin-node-resolve": "^8.0.0",
     "@rollup/plugin-replace": "^2.2.0",
-    "@types/mocha": "^5.2.5",
+    "@types/mocha": "^7.0.2",
     "@types/node": "^8.0.0",
-    "@typescript-eslint/eslint-plugin": "^2.0.0",
-    "@typescript-eslint/parser": "^2.0.0",
     "assert": "^1.4.1",
-    "cross-env": "^6.0.3",
+    "cross-env": "^7.0.2",
     "delay": "^4.2.0",
-    "eslint": "^6.1.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-plugin-no-null": "^1.0.2",
-    "eslint-plugin-no-only-tests": "^2.3.0",
-    "eslint-plugin-promise": "^4.1.1",
-    "karma": "^4.0.1",
+    "eslint": "^7.15.0",
+    "karma": "^5.1.0",
     "karma-chrome-launcher": "^3.0.0",
     "karma-coverage": "^2.0.0",
     "karma-edge-launcher": "^0.4.2",
@@ -89,22 +91,19 @@
     "karma-firefox-launcher": "^1.1.0",
     "karma-ie-launcher": "^1.0.0",
     "karma-junit-reporter": "^2.0.1",
-    "karma-mocha": "^1.3.0",
+    "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
-    "karma-remap-coverage": "^0.1.5",
-    "mocha": "^6.2.2",
+    "karma-remap-istanbul": "^0.6.0",
+    "mocha": "^7.1.1",
     "mocha-junit-reporter": "^1.18.0",
-    "mocha-multi": "^1.1.3",
     "nyc": "^14.0.0",
     "prettier": "^1.16.4",
     "rimraf": "^3.0.0",
     "rollup": "^1.16.3",
-    "rollup-plugin-commonjs": "^10.0.0",
-    "rollup-plugin-multi-entry": "^2.1.0",
-    "rollup-plugin-node-resolve": "^5.0.2",
     "rollup-plugin-sourcemaps": "^0.4.2",
     "rollup-plugin-terser": "^5.1.1",
     "ts-node": "^8.3.0",
-    "typescript": "~3.6.4"
+    "typescript": "4.1.2",
+    "typedoc": "0.15.0"
   }
 }

package/{src/shims-public.d.ts → shims-public.d.ts}

@@ -1,2 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
 // forward declaration of Event in case DOM libs are not present.
 interface Event {}

package/types/src/AbortController.d.ts

@@ -5,6 +5,7 @@ import { AbortSignal, AbortSignalLike } from "./AbortSignal";
  * error matches `"AbortError"`.
  *
  * @example
+ * ```ts
  * const controller = new AbortController();
  * controller.abort();
  * try {
@@ -14,6 +15,7 @@ import { AbortSignal, AbortSignalLike } from "./AbortSignal";
  *     // handle abort error here.
  *   }
  * }
+ * ```
  */
 export declare class AbortError extends Error {
     constructor(message?: string);
@@ -23,43 +25,43 @@ export declare class AbortError extends Error {
  * that an asynchronous operation should be aborted.
  *
  * @example
- * // Abort an operation when another event fires
+ * Abort an operation when another event fires
+ * ```ts
  * const controller = new AbortController();
  * const signal = controller.signal;
  * doAsyncWork(signal);
  * button.addEventListener('click', () => controller.abort());
+ * ```
  *
  * @example
- * // Share aborter cross multiple operations in 30s
+ * Share aborter cross multiple operations in 30s
+ * ```ts
  * // Upload the same data to 2 different data centers at the same time,
  * // abort another when any of them is finished
  * const controller = AbortController.withTimeout(30 * 1000);
  * doAsyncWork(controller.signal).then(controller.abort);
  * doAsyncWork(controller.signal).then(controller.abort);
+ *```
  *
  * @example
- * // Cascaded aborting
+ * Cascaded aborting
+ * ```ts
  * // All operations can't take more than 30 seconds
  * const aborter = Aborter.timeout(30 * 1000);
  *
  * // Following 2 operations can't take more than 25 seconds
  * await doAsyncWork(aborter.withTimeout(25 * 1000));
  * await doAsyncWork(aborter.withTimeout(25 * 1000));
- *
- * @export
- * @class AbortController
- * @implements {AbortSignalLike}
+ * ```
  */
 export declare class AbortController {
     private _signal;
     /**
-     * @param {AbortSignalLike[]} [parentSignals] The AbortSignals that will signal aborted on the AbortSignal associated with this controller.
-     * @constructor
+     * @param parentSignals - The AbortSignals that will signal aborted on the AbortSignal associated with this controller.
      */
     constructor(parentSignals?: AbortSignalLike[]);
     /**
-     * @param {...AbortSignalLike} parentSignals The AbortSignals that will signal aborted on the AbortSignal associated with this controller.
-     * @constructor
+     * @param parentSignals - The AbortSignals that will signal aborted on the AbortSignal associated with this controller.
      */
     constructor(...parentSignals: AbortSignalLike[]);
     /**
@@ -67,23 +69,16 @@ export declare class AbortController {
      * when the abort method is called on this controller.
      *
      * @readonly
-     * @type {AbortSignal}
-     * @memberof AbortController
      */
-    readonly signal: AbortSignal;
+    get signal(): AbortSignal;
     /**
      * Signal that any operations passed this controller's associated abort signal
      * to cancel any remaining work and throw an `AbortError`.
-     *
-     * @memberof AbortController
      */
     abort(): void;
     /**
      * Creates a new AbortSignal instance that will abort after the provided ms.
-     *
-     * @static
-     * @params {number} ms Elapsed time in milliseconds to trigger an abort.
-     * @returns {AbortSignal}
+     * @param ms - Elapsed time in milliseconds to trigger an abort.
      */
     static timeout(ms: number): AbortSignal;
 }

package/types/src/AbortController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbortController.d.ts","sourceRoot":"","sources":["../../src/AbortController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,eAAe,EAAE,MAAM,eAAe,CAAC;AAE1E;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,UAAW,SAAQ,KAAK;gBACvB,OAAO,CAAC,EAAE,MAAM;CAI7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAc;IAE7B;;;OAGG;gBACS,aAAa,CAAC,EAAE,eAAe,EAAE;IAC7C;;;OAGG;gBACS,GAAG,aAAa,EAAE,eAAe,EAAE;IAyB/C;;;;;;;OAOG;aACQ,MAAM;IAIjB;;;;;OAKG;IACH,KAAK;IAIL;;;;;;OAMG;WACW,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW;CAS/C"}
+{"version":3,"file":"AbortController.d.ts","sourceRoot":"","sources":["../../src/AbortController.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAe,eAAe,EAAE,MAAM,eAAe,CAAC;AAE1E;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,UAAW,SAAQ,KAAK;gBACvB,OAAO,CAAC,EAAE,MAAM;CAI7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAc;IAE7B;;OAEG;gBACS,aAAa,CAAC,EAAE,eAAe,EAAE;IAC7C;;OAEG;gBACS,GAAG,aAAa,EAAE,eAAe,EAAE;IA2B/C;;;;;OAKG;IACH,IAAW,MAAM,IAAI,WAAW,CAE/B;IAED;;;OAGG;IACH,KAAK,IAAI,IAAI;IAIb;;;OAGG;WACW,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW;CAS/C"}

package/types/src/AbortSignal.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="../../src/shims-public.d.ts" />
+/// <reference path="../../shims-public.d.ts" />
 /**
  * Allows the request to be aborted upon firing of the "abort" event.
  * Compatible with the browser built-in AbortSignal and common polyfills.
@@ -25,12 +25,10 @@ export interface AbortSignalLike {
  * cannot or will not ever be cancelled.
  *
  * @example
- * // Abort without timeout
+ * Abort without timeout
+ * ```ts
  * await doAsyncWork(AbortSignal.none);
- *
- * @export
- * @class AbortSignal
- * @implements {AbortSignalLike}
+ * ```
  */
 export declare class AbortSignal implements AbortSignalLike {
     constructor();
@@ -38,39 +36,30 @@ export declare class AbortSignal implements AbortSignalLike {
      * Status of whether aborted or not.
      *
      * @readonly
-     * @type {boolean}
-     * @memberof AbortSignal
      */
-    readonly aborted: boolean;
+    get aborted(): boolean;
     /**
      * Creates a new AbortSignal instance that will never be aborted.
      *
      * @readonly
-     * @static
-     * @type {AbortSignal}
-     * @memberof AbortSignal
      */
-    static readonly none: AbortSignal;
+    static get none(): AbortSignal;
     /**
      * onabort event listener.
-     *
-     * @memberof AbortSignal
      */
     onabort: ((ev?: Event) => any) | null;
     /**
      * Added new "abort" event listener, only support "abort" event.
      *
-     * @param {"abort"} _type Only support "abort" event
-     * @param {(this: AbortSignalLike, ev: any) => any} listener
-     * @memberof AbortSignal
+     * @param _type - Only support "abort" event
+     * @param listener - The listener to be added
      */
     addEventListener(_type: "abort", listener: (this: AbortSignalLike, ev: any) => any): void;
     /**
      * Remove "abort" event listener, only support "abort" event.
      *
-     * @param {"abort"} _type Only support "abort" event
-     * @param {(this: AbortSignalLike, ev: any) => any} listener
-     * @memberof AbortSignal
+     * @param _type - Only support "abort" event
+     * @param listener - The listener to be removed
      */
     removeEventListener(_type: "abort", listener: (this: AbortSignalLike, ev: any) => any): void;
     /**
@@ -85,7 +74,6 @@ export declare class AbortSignal implements AbortSignalLike {
  * - If there is a timeout, the timer will be cancelled.
  * - If aborted is true, nothing will happen.
  *
- * @returns
  * @internal
  */
 export declare function abortSignal(signal: AbortSignal): void;

package/types/src/AbortSignal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbortSignal.d.ts","sourceRoot":"","sources":["../../src/AbortSignal.ts"],"names":[],"mappings":";AAMA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,gBAAgB,CACd,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,EACjD,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI,CAAC;IACR;;OAEG;IACH,mBAAmB,CACjB,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,EACjD,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI,CAAC;CACT;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,WAAY,YAAW,eAAe;;IAMjD;;;;;;OAMG;aACQ,OAAO,EAAI,OAAO;IAQ7B;;;;;;;OAOG;oBACe,IAAI,EAAI,WAAW;IAIrC;;;;OAIG;IACI,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,KAAK,GAAG,CAAC,GAAG,IAAI,CAAQ;IAEpD;;;;;;OAMG;IACI,gBAAgB,CAErB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,GAChD,IAAI;IASP;;;;;;OAMG;IACI,mBAAmB,CAExB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,GAChD,IAAI;IAaP;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO;CAKtC;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,QAiB9C"}
+{"version":3,"file":"AbortSignal.d.ts","sourceRoot":"","sources":["../../src/AbortSignal.ts"],"names":[],"mappings":";AAWA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,gBAAgB,CACd,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,EACjD,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI,CAAC;IACR;;OAEG;IACH,mBAAmB,CACjB,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,EACjD,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI,CAAC;CACT;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,WAAY,YAAW,eAAe;;IAMjD;;;;OAIG;IACH,IAAW,OAAO,IAAI,OAAO,CAM5B;IAED;;;;OAIG;IACH,WAAkB,IAAI,IAAI,WAAW,CAEpC;IAED;;OAEG;IACI,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,KAAK,GAAG,CAAC,GAAG,IAAI,CAAQ;IAEpD;;;;;OAKG;IACI,gBAAgB,CAErB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,GAChD,IAAI;IASP;;;;;OAKG;IACI,mBAAmB,CAExB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,KAAK,GAAG,GAChD,IAAI;IAaP;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO;CAKtC;AAED;;;;;;;;GAQG;AAEH,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAiBrD"}

package/types/src/{aborter.d.ts → index.d.ts}

@@ -1,3 +1,3 @@
 export { AbortController, AbortError } from "./AbortController";
 export { AbortSignal, AbortSignalLike } from "./AbortSignal";
-//# sourceMappingURL=aborter.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}

package/dist-esm/src/aborter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"aborter.js","sourceRoot":"","sources":["../../src/aborter.ts"],"names":[],"mappings":"AAAA,qBAAqB;AACrB,kCAAkC;AAClC,uHAAuH;AACvH,qDAAqD;AACrD,2GAA2G;AAE3G,2CAA2C;AAC3C,4BAA4B;AAE5B,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAC"}

package/src/AbortController.ts

@@ -1,133 +0,0 @@
-import { AbortSignal, abortSignal, AbortSignalLike } from "./AbortSignal";
-
-/**
- * This error is thrown when an asynchronous operation has been aborted.
- * Check for this error by testing the `name` that the name property of the
- * error matches `"AbortError"`.
- *
- * @example
- * const controller = new AbortController();
- * controller.abort();
- * try {
- *   doAsyncWork(controller.signal)
- * } catch (e) {
- *   if (e.name === 'AbortError') {
- *     // handle abort error here.
- *   }
- * }
- */
-export class AbortError extends Error {
-  constructor(message?: string) {
-    super(message);
-    this.name = "AbortError";
-  }
-}
-
-/**
- * An AbortController provides an AbortSignal and the associated controls to signal
- * that an asynchronous operation should be aborted.
- *
- * @example
- * // Abort an operation when another event fires
- * const controller = new AbortController();
- * const signal = controller.signal;
- * doAsyncWork(signal);
- * button.addEventListener('click', () => controller.abort());
- *
- * @example
- * // Share aborter cross multiple operations in 30s
- * // Upload the same data to 2 different data centers at the same time,
- * // abort another when any of them is finished
- * const controller = AbortController.withTimeout(30 * 1000);
- * doAsyncWork(controller.signal).then(controller.abort);
- * doAsyncWork(controller.signal).then(controller.abort);
- *
- * @example
- * // Cascaded aborting
- * // All operations can't take more than 30 seconds
- * const aborter = Aborter.timeout(30 * 1000);
- *
- * // Following 2 operations can't take more than 25 seconds
- * await doAsyncWork(aborter.withTimeout(25 * 1000));
- * await doAsyncWork(aborter.withTimeout(25 * 1000));
- *
- * @export
- * @class AbortController
- * @implements {AbortSignalLike}
- */
-export class AbortController {
-  private _signal: AbortSignal;
-
-  /**
-   * @param {AbortSignalLike[]} [parentSignals] The AbortSignals that will signal aborted on the AbortSignal associated with this controller.
-   * @constructor
-   */
-  constructor(parentSignals?: AbortSignalLike[]);
-  /**
-   * @param {...AbortSignalLike} parentSignals The AbortSignals that will signal aborted on the AbortSignal associated with this controller.
-   * @constructor
-   */
-  constructor(...parentSignals: AbortSignalLike[]);
-  constructor(parentSignals?: any) {
-    this._signal = new AbortSignal();
-
-    if (!parentSignals) {
-      return;
-    }
-    // coerce parentSignals into an array
-    if (!Array.isArray(parentSignals)) {
-      parentSignals = arguments;
-    }
-    for (const parentSignal of parentSignals) {
-      // if the parent signal has already had abort() called,
-      // then call abort on this signal as well.
-      if (parentSignal.aborted) {
-        this.abort();
-      } else {
-        // when the parent signal aborts, this signal should as well.
-        parentSignal.addEventListener("abort", () => {
-          this.abort();
-        });
-      }
-    }
-  }
-
-  /**
-   * The AbortSignal associated with this controller that will signal aborted
-   * when the abort method is called on this controller.
-   *
-   * @readonly
-   * @type {AbortSignal}
-   * @memberof AbortController
-   */
-  public get signal() {
-    return this._signal;
-  }
-
-  /**
-   * Signal that any operations passed this controller's associated abort signal
-   * to cancel any remaining work and throw an `AbortError`.
-   *
-   * @memberof AbortController
-   */
-  abort() {
-    abortSignal(this._signal);
-  }
-
-  /**
-   * Creates a new AbortSignal instance that will abort after the provided ms.
-   *
-   * @static
-   * @params {number} ms Elapsed time in milliseconds to trigger an abort.
-   * @returns {AbortSignal}
-   */
-  public static timeout(ms: number): AbortSignal {
-    const signal = new AbortSignal();
-    const timer = setTimeout(abortSignal, ms, signal);
-    // Prevent the active Timer from keeping the Node.js event loop active.
-    if (typeof timer.unref === "function") {
-      timer.unref();
-    }
-    return signal;
-  }
-}

package/src/AbortSignal.ts

@@ -1,170 +0,0 @@
-/// <reference path="./shims-public.d.ts" />
-type AbortEventListener = (this: AbortSignalLike, ev?: any) => any;
-
-const listenersMap = new WeakMap<AbortSignal, AbortEventListener[]>();
-const abortedMap = new WeakMap<AbortSignal, boolean>();
-
-/**
- * Allows the request to be aborted upon firing of the "abort" event.
- * Compatible with the browser built-in AbortSignal and common polyfills.
- */
-export interface AbortSignalLike {
-  /**
-   * Indicates if the signal has already been aborted.
-   */
-  readonly aborted: boolean;
-  /**
-   * Add new "abort" event listener, only support "abort" event.
-   */
-  addEventListener(
-    type: "abort",
-    listener: (this: AbortSignalLike, ev: any) => any,
-    options?: any
-  ): void;
-  /**
-   * Remove "abort" event listener, only support "abort" event.
-   */
-  removeEventListener(
-    type: "abort",
-    listener: (this: AbortSignalLike, ev: any) => any,
-    options?: any
-  ): void;
-}
-
-/**
- * An aborter instance implements AbortSignal interface, can abort HTTP requests.
- *
- * - Call AbortSignal.none to create a new AbortSignal instance that cannot be cancelled.
- * Use `AbortSignal.none` when you are required to pass a cancellation token but the operation
- * cannot or will not ever be cancelled.
- *
- * @example
- * // Abort without timeout
- * await doAsyncWork(AbortSignal.none);
- *
- * @export
- * @class AbortSignal
- * @implements {AbortSignalLike}
- */
-export class AbortSignal implements AbortSignalLike {
-  constructor() {
-    listenersMap.set(this, []);
-    abortedMap.set(this, false);
-  }
-
-  /**
-   * Status of whether aborted or not.
-   *
-   * @readonly
-   * @type {boolean}
-   * @memberof AbortSignal
-   */
-  public get aborted(): boolean {
-    if (!abortedMap.has(this)) {
-      throw new TypeError("Expected `this` to be an instance of AbortSignal.");
-    }
-
-    return abortedMap.get(this)!;
-  }
-
-  /**
-   * Creates a new AbortSignal instance that will never be aborted.
-   *
-   * @readonly
-   * @static
-   * @type {AbortSignal}
-   * @memberof AbortSignal
-   */
-  public static get none(): AbortSignal {
-    return new AbortSignal();
-  }
-
-  /**
-   * onabort event listener.
-   *
-   * @memberof AbortSignal
-   */
-  public onabort: ((ev?: Event) => any) | null = null;
-
-  /**
-   * Added new "abort" event listener, only support "abort" event.
-   *
-   * @param {"abort"} _type Only support "abort" event
-   * @param {(this: AbortSignalLike, ev: any) => any} listener
-   * @memberof AbortSignal
-   */
-  public addEventListener(
-    // tslint:disable-next-line:variable-name
-    _type: "abort",
-    listener: (this: AbortSignalLike, ev: any) => any
-  ): void {
-    if (!listenersMap.has(this)) {
-      throw new TypeError("Expected `this` to be an instance of AbortSignal.");
-    }
-
-    const listeners = listenersMap.get(this)!;
-    listeners.push(listener);
-  }
-
-  /**
-   * Remove "abort" event listener, only support "abort" event.
-   *
-   * @param {"abort"} _type Only support "abort" event
-   * @param {(this: AbortSignalLike, ev: any) => any} listener
-   * @memberof AbortSignal
-   */
-  public removeEventListener(
-    // tslint:disable-next-line:variable-name
-    _type: "abort",
-    listener: (this: AbortSignalLike, ev: any) => any
-  ): void {
-    if (!listenersMap.has(this)) {
-      throw new TypeError("Expected `this` to be an instance of AbortSignal.");
-    }
-
-    const listeners = listenersMap.get(this)!;
-
-    const index = listeners.indexOf(listener);
-    if (index > -1) {
-      listeners.splice(index, 1);
-    }
-  }
-
-  /**
-   * Dispatches a synthetic event to the AbortSignal.
-   */
-  dispatchEvent(_event: Event): boolean {
-    throw new Error(
-      "This is a stub dispatchEvent implementation that should not be used.  It only exists for type-checking purposes."
-    );
-  }
-}
-
-/**
- * Helper to trigger an abort event immediately, the onabort and all abort event listeners will be triggered.
- * Will try to trigger abort event for all linked AbortSignal nodes.
- *
- * - If there is a timeout, the timer will be cancelled.
- * - If aborted is true, nothing will happen.
- *
- * @returns
- * @internal
- */
-export function abortSignal(signal: AbortSignal) {
-  if (signal.aborted) {
-    return;
-  }
-
-  if (signal.onabort) {
-    signal.onabort.call(signal);
-  }
-
-  const listeners = listenersMap.get(signal)!;
-  if (listeners) {
-    listeners.forEach((listener) => {
-      listener.call(signal, { type: "abort" });
-    });
-  }
-
-  abortedMap.set(signal, true);
-}