Add types for extra request options (#1448)

* Add types for extra request options * tests and fewer props Co-authored-by: Pavel Krymets <pakrym@stripe.com>
stripe · Jun 9, 2022 · 5135ab0 · 5135ab0
1 parent 5416318
commit 5135ab0
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/test/StripeResource.spec.js b/test/StripeResource.spec.js
@@ -201,6 +201,24 @@ describe('StripeResource', () => {
           }
         );
       });
+
+      it('allows overriding host', (done) => {
+        const scope = nock('https://myhost')
+          .get('/v1/accounts/acct_123')
+          .reply(200, '{}');
+
+        realStripe.accounts.retrieve(
+          'acct_123',
+          {},
+          {
+            host: 'myhost',
+          },
+          (err, response) => {
+            done(err);
+            scope.done();
+          }
+        );
+      });
     });
   });
 

diff --git a/types/lib.d.ts b/types/lib.d.ts
@@ -103,10 +103,19 @@ declare module 'stripe' {
        */
       timeout?: number;
 
+      /**
+       * Specify the host to use for API Requests.
+       */
       host?: string;
 
+      /**
+       * Specify the port to use for API Requests.
+       */
       port?: string | number;
 
+      /**
+       * Specify the HTTP protool to use for API Requests.
+       */
       protocol?: HttpProtocol;
 
       /**
@@ -170,6 +179,11 @@ declare module 'stripe' {
        * Specify a timeout for this request in milliseconds.
        */
       timeout?: number;
+
+      /**
+       * Specify the host for this request.
+       */
+      host?: string;
     }
 
     export type Response<T> = T & {

diff --git a/types/test/typescriptTest.ts b/types/test/typescriptTest.ts
@@ -294,3 +294,7 @@ Stripe.StripeError.generate({
 Stripe.errors.StripeError.generate({
   type: 'card_error',
 });
+
+stripe.accounts.retrieve('123', {
+  host: 'my_host',
+});