feat: add support for aborting requests (#42)

googleapis · Feb 12, 2019 · 1b47153 · 1b47153
1 parent 17e521f
commit 1b47153
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -126,7 +126,11 @@ gaxios.request({url: '/data'}).then(...);
   },
 
   // Enables default configuration for retries.
-  retry: boolean;
+  retry: boolean,
+
+  // Cancelling a request requires the `abort-controller` library.
+  // See https://github.com/bitinn/node-fetch#request-cancellation-with-abortsignal
+  signal?: AbortSignal
 }
 ```
 

diff --git a/package.json b/package.json
@@ -57,6 +57,7 @@
     "typescript": "~3.3.0"
   },
   "dependencies": {
+    "abort-controller": "^2.0.2",
     "extend": "^3.0.2",
     "https-proxy-agent": "^2.2.1",
     "node-fetch": "^2.2.0"

diff --git a/src/common.ts b/src/common.ts
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import {AbortSignal} from 'abort-controller';
 import {Agent} from 'https';
 
 export class GaxiosError<T = any> extends Error {
@@ -69,6 +70,7 @@ export interface GaxiosOptions {
   validateStatus?: (status: number) => boolean;
   retryConfig?: RetryConfig;
   retry?: boolean;
+  signal?: AbortSignal;
   size?: number;
 }