feat: allow a default timeout to be set for clients (#196)

Modern-Treasury · Aug 15, 2023 · 5403497 · 5403497
1 parent c091449
commit 5403497
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -175,13 +175,13 @@ await modernTreasury.externalAccounts.list({
 
 ### Timeouts
 
-Requests time out after 60 seconds by default. You can configure this with a `timeout` option:
+Requests time out after 1 minute by default. You can configure this with a `timeout` option:
 
 <!-- prettier-ignore -->
 ```ts
 // Configure the default for all requests:
 const modernTreasury = new ModernTreasury({
-  timeout: 20 * 1000, // 20 seconds (default is 60s)
+  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
   organizationId: 'my-organization-ID',
 });
 

diff --git a/src/core.ts b/src/core.ts
@@ -128,7 +128,7 @@ export abstract class APIClient {
   constructor({
     baseURL,
     maxRetries,
-    timeout = 60 * 1000, // 60s
+    timeout = 60000, // 1 minute
     httpAgent,
     fetch: overridenFetch,
   }: {

diff --git a/src/index.ts b/src/index.ts
@@ -108,7 +108,7 @@ export class ModernTreasury extends Core.APIClient {
 
     super({
       baseURL: options.baseURL!,
-      timeout: options.timeout,
+      timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
       fetch: options.fetch,