comment preferred vs legacy control flow

smithy-lang · Jun 18, 2024 · 96e07c7 · 96e07c7
1 parent 28c0ea5
commit 96e07c7
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/packages/fetch-http-handler/src/fetch-http-handler.ts b/packages/fetch-http-handler/src/fetch-http-handler.ts
@@ -165,8 +165,10 @@ export class FetchHttpHandler implements HttpHandler<FetchHttpHandlerConfig> {
             reject(abortError);
           };
           if (typeof (abortSignal as AbortSignal).addEventListener === "function") {
+            // preferred.
             (abortSignal as AbortSignal).addEventListener("abort", onAbort);
           } else {
+            // backwards compatibility
             abortSignal.onabort = onAbort;
           }
         })

diff --git a/packages/node-http-handler/src/node-http-handler.ts b/packages/node-http-handler/src/node-http-handler.ts
@@ -240,8 +240,10 @@ export class NodeHttpHandler implements HttpHandler<NodeHttpHandlerOptions> {
           reject(abortError);
         };
         if (typeof (abortSignal as AbortSignal).addEventListener === "function") {
+          // preferred.
           (abortSignal as AbortSignal).addEventListener("abort", onAbort);
         } else {
+          // backwards compatibility
           abortSignal.onabort = onAbort;
         }
       }

diff --git a/packages/node-http-handler/src/node-http2-handler.ts b/packages/node-http-handler/src/node-http2-handler.ts
@@ -188,8 +188,10 @@ export class NodeHttp2Handler implements HttpHandler<NodeHttp2HandlerOptions> {
           rejectWithDestroy(abortError);
         };
         if (typeof (abortSignal as AbortSignal).addEventListener === "function") {
+          // preferred.
           (abortSignal as AbortSignal).addEventListener("abort", onAbort);
         } else {
+          // backwards compatibility
           abortSignal.onabort = onAbort;
         }
       }

diff --git a/packages/util-waiter/src/createWaiter.ts b/packages/util-waiter/src/createWaiter.ts
@@ -8,8 +8,10 @@ const abortTimeout = async (abortSignal: AbortSignal | DeprecatedAbortSignal): P
   return new Promise((resolve) => {
     const onAbort = () => resolve({ state: WaiterState.ABORTED });
     if (typeof (abortSignal as AbortSignal).addEventListener === "function") {
+      // preferred.
       (abortSignal as AbortSignal).addEventListener("abort", onAbort);
     } else {
+      // backwards compatibility
       abortSignal.onabort = onAbort;
     }
   });