feat: add support for custom http and https agents (#966)

ethersphere · Oct 24, 2024 · 7c5662b · 7c5662b
1 parent 6e695b7
commit 7c5662b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -158,6 +158,18 @@ const bee = new Bee('http://localhost:1633')
 const uploadResult = await bee.uploadFilesFromDirectory(batchId, './path/to/gallery/')
 ```
 
+### Customize http/https agent and headers
+
+```js
+const bee = new Bee('http://localhost:1633', {
+  httpAgent: new http.Agent({ keepAlive: true }),
+  httpsAgent: new https.Agent({ keepAlive: true }),
+  headers: {
+    Authorization: 'Basic ' + Buffer.from('username:password').toString('base64'),
+  },
+})
+```
+
 [**Check out our examples repo for some more ideas on how to use `bee-js`**](https://github.com/ethersphere/examples-js)
 
 ## Documentation

diff --git a/src/bee.ts b/src/bee.ts
@@ -184,6 +184,8 @@ export class Bee {
       timeout: options?.timeout ?? false,
       headers: options?.headers,
       onRequest: options?.onRequest,
+      httpAgent: options?.httpAgent,
+      httpsAgent: options?.httpsAgent,
     }
   }
 

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -87,6 +87,8 @@ export type BeeRequestOptions = {
   timeout?: number | false
   headers?: Record<string, string>
   onRequest?: (request: BeeRequest) => void
+  httpAgent?: any
+  httpsAgent?: any
 }
 
 export interface BeeOptions extends BeeRequestOptions {