docs(abort-controller): update abort-controller documentation (#4762)

aws · May 25, 2023 · 8874468 · 8874468
1 parent 4e4c7f4
commit 8874468
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/packages/abort-controller/src/AbortController.ts b/packages/abort-controller/src/AbortController.ts
@@ -2,9 +2,13 @@ import { AbortController as IAbortController } from "@aws-sdk/types";
 
 import { AbortSignal } from "./AbortSignal";
 
+export { IAbortController };
+
 /**
  * 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.
+ * Use native implementation in browsers or Node.js \>=15.4.0.
+ *
+ * @public
  */
 export class AbortController implements IAbortController {
   public readonly signal: AbortSignal = new AbortSignal();

diff --git a/packages/abort-controller/src/AbortSignal.ts b/packages/abort-controller/src/AbortSignal.ts
@@ -1,5 +1,10 @@
 import { AbortHandler, AbortSignal as IAbortSignal } from "@aws-sdk/types";
 
+export { AbortHandler, IAbortSignal };
+
+/**
+ * @public
+ */
 export class AbortSignal implements IAbortSignal {
   public onabort: AbortHandler | null = null;
   private _aborted = false;

diff --git a/packages/abort-controller/src/index.ts b/packages/abort-controller/src/index.ts
@@ -1,2 +1,9 @@
+/**
+ * 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.
+ *
+ * @deprecated Use standard implementations in [Browsers](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) and [Node.js](https://nodejs.org/docs/latest/api/globals.html#class-abortcontroller)
+ * @packageDocumentation
+ */
 export * from "./AbortController";
 export * from "./AbortSignal";