lambda-essentials-ts 5.1.6 → 5.1.7

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
+## [5.1.7] - 2022-12-13
+
+### Changed
+
+Add timeout option in HttpClient. If no value is provided the default is no timeout.
+
 ## [5.1.6] - 2022-11-30
 
 ### Changed

package/README.md

@@ -69,6 +69,7 @@ let httpClient = new HttpClient({
       query: false, // also cache requests with query parameters
     },
   },
+  timeout: 1000
 });
 
 let headers = {};

package/lib/httpClient/httpClient.d.ts

@@ -16,6 +16,7 @@ export default class HttpClient {
     private readonly client;
     private readonly enableRetry;
     private readonly enableCache;
+    private readonly timeout?;
     /**
      * Create a new Instance of the HttpClient
      */
@@ -94,6 +95,11 @@ export interface HttpClientOptions {
      * @link https://github.com/JustinBeckwith/retry-axios/blob/v2.6.0/src/index.ts#L11
      */
     retryOptions?: RetryConfig;
+    /**
+     * Number of milliseconds before the request times out. Default or `0` is no time out.
+     * @link https://github.com/axios/axios/blob/main/README.md#request-config
+     */
+    timeout?: number;
 }
 /**
  * Log options object.

package/lib/httpClient/httpClient.js

@@ -61,6 +61,7 @@ class HttpClient {
         this.correlationIdResolverFunction = options === null || options === void 0 ? void 0 : options.correlationIdResolver;
         this.enableCache = (_c = options === null || options === void 0 ? void 0 : options.enableCache) !== null && _c !== void 0 ? _c : false;
         this.enableRetry = (_d = options === null || options === void 0 ? void 0 : options.enableRetry) !== null && _d !== void 0 ? _d : false;
+        this.timeout = options === null || options === void 0 ? void 0 : options.timeout;
         this.client =
             (_e = options === null || options === void 0 ? void 0 : options.client) !== null && _e !== void 0 ? _e : axios_1.default.create({
                 adapter: (() => {
@@ -101,6 +102,9 @@ class HttpClient {
             // attach retry-axios
             rax.attach(this.client);
         }
+        if (this.timeout) {
+            this.client.defaults.timeout = this.timeout;
+        }
         this.client.interceptors.request.use((config) => {
             if (this.logOptions.enabledLogs.includes(HttpLogType.requests)) {
                 this.logFunction({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-essentials-ts",
-  "version": "5.1.6",
+  "version": "5.1.7",
   "description": "A selection of the finest modules supporting authorization, API routing, error handling, logging and sending HTTP requests.",
   "main": "lib/index.js",
   "private": false,