docs(abort-controller): add message about browsers (#4591)

* docs(abort-controller): add message about browsers * docs(abort-controller): update packages/abort-controller/src/AbortController.ts Co-authored-by: Trivikram Kamat <[email protected]> * fix(types): global AbortController type compat --------- Co-authored-by: Trivikram Kamat <[email protected]>
aws · Mar 30, 2023 · 324e89e · 324e89e
1 parent ed7d81e
commit 324e89e
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 2 deletions.
diff --git a/packages/abort-controller/src/AbortController.ts b/packages/abort-controller/src/AbortController.ts
@@ -2,6 +2,10 @@ import { AbortController as IAbortController } from "@aws-sdk/types";
 
 import { AbortSignal } from "./AbortSignal";
 
+/**
+ * This implementation was added as Node.js didn't support AbortController prior to 15.x
+ * Use native implementation in browsers or Node.js >=15.4.0.
+ */
 export class AbortController implements IAbortController {
   public readonly signal: AbortSignal = new AbortSignal();
 

diff --git a/packages/types/package.json b/packages/types/package.json
@@ -13,7 +13,7 @@
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
-    "test": "exit 0"
+    "test": "tsc -p tsconfig.test.json"
   },
   "author": {
     "name": "AWS SDK for JavaScript Team",

diff --git a/packages/types/src/abort.spec.ts b/packages/types/src/abort.spec.ts
@@ -0,0 +1,5 @@
+import { AbortSignal } from "./abort";
+
+// asserts that the global abortController signal is compatible with
+// our signal type.
+const signal: AbortSignal = new AbortController().signal;
diff --git a/packages/types/src/abort.ts b/packages/types/src/abort.ts
@@ -23,7 +23,7 @@ export interface AbortSignal {
    * A function to be invoked when the action represented by this signal has
    * been cancelled.
    */
-  onabort: AbortHandler | null;
+  onabort: AbortHandler | Function | null;
 }
 
 /**

diff --git a/packages/types/tsconfig.test.json b/packages/types/tsconfig.test.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "src",
+    "noEmit": true
+  },
+  "extends": "../../tsconfig.cjs.json",
+  "include": ["src/"],
+  "exclude": []
+}