feat(arcgis-rest-request): add support for AbortSignal

IRequestOptions.signal is passed to fetch()
Esri · Mar 29, 2022 · 1462f1f · 1462f1f
1 parent 446b8f0
commit 1462f1f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/packages/arcgis-rest-request/src/request.ts b/packages/arcgis-rest-request/src/request.ts
@@ -245,6 +245,7 @@ export function internalRequest(
 
   const fetchOptions: RequestInit = {
     method: httpMethod,
+    signal: options.signal,
     /* ensures behavior mimics XMLHttpRequest.
     needed to support sending IWA cookies */
     credentials: options.credentials || "same-origin"

diff --git a/packages/arcgis-rest-request/src/utils/IRequestOptions.ts b/packages/arcgis-rest-request/src/utils/IRequestOptions.ts
@@ -51,6 +51,11 @@ export interface IRequestOptions {
   headers?: {
     [key: string]: any;
   };
+  /**
+   * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) object instance; allows you to abort a request and via an [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+   */
+  signal?: AbortSignal;
+
   /**
    * Suppress any ArcGIS REST JS related warnings for this request.
    */