Merge pull request #899 from goodeggs/types/add-missing-agent-option

types: add missing agent option

Author: jonasgraterol

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-fetch",
-  "version": "9.0.5",
+  "version": "9.0.6",
   "description": "A wrapper around ES6 fetch to simplify interacting with JSON APIs.",
   "author": "Good Eggs <[email protected]>",
   "contributors": [

src/index.ts

@@ -1,11 +1,18 @@
 import 'isomorphic-fetch';
+
+import {Agent} from 'http';
 import promiseRetry from 'promise-retry';
 
 import getRequestOptions from './get_request_options';
 
 export type ShouldRetry = (responseOrError: Response | Error) => boolean;
 
 export interface JsonFetchOptions extends Omit<RequestInit, 'body'> {
+  // node-fetch extensions (not available in browsers, i.e. whatwg-fetch) –
+  // see https://github.com/node-fetch/node-fetch/blob/8721d79208ad52c44fffb4b5b5cfa13b936022c3/%40types/index.d.ts#L76:
+  agent?: Agent | ((parsedUrl: URL) => Agent);
+
+  // goodeggs-fetch options:
   body?: Record<string, unknown>;
   shouldRetry?: (responseOrError: Response | Error) => boolean;
   retry?: Parameters<typeof promiseRetry>[0];