fixing wrong Error type (#121)

* fixing wrong Error type * fixing the type for onRetry and shouldRetry * bump to version 0.11.5 in package.json * Update CHANGELOG.md * fixing lint * just retriggering stuck checks * just retriggering stuck checks * just retriggering stuck checks * debuggibg zapper config * adding type array to responce body * bumping version in package-lock.json and reverting yarn.lock ignore --------- Co-authored-by: hakroush <[email protected]>
zalando-incubator · Oct 11, 2023 · 5949440 · 5949440
1 parent 6a5c0ab
commit 5949440
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 0.11.5
+* use ServiceClientError type for Errors in shouldRetry and onRetry options.
+
 ## 0.11.3
 
 * Use `timing` option from client if `timing` is not set in the request options. #91

diff --git a/lib/client.ts b/lib/client.ts
@@ -92,10 +92,13 @@ export class ServiceClientOptions {
     minTimeout?: number;
     maxTimeout?: number;
     randomize?: boolean;
-    shouldRetry?: (err?: Error, req?: ServiceClientRequestOptions) => boolean;
+    shouldRetry?: (
+      err?: ServiceClientError,
+      req?: ServiceClientRequestOptions
+    ) => boolean;
     onRetry?: (
       currentAttempt?: number,
-      err?: Error,
+      err?: ServiceClientError,
       req?: ServiceClientRequestOptions
     ) => void;
   };
@@ -117,10 +120,13 @@ class ServiceClientStrictOptions {
     minTimeout: number;
     maxTimeout: number;
     randomize: boolean;
-    shouldRetry: (err?: Error, req?: ServiceClientRequestOptions) => boolean;
+    shouldRetry: (
+      err?: ServiceClientError,
+      req?: ServiceClientRequestOptions
+    ) => boolean;
     onRetry: (
       currentAttempt?: number,
-      err?: Error,
+      err?: ServiceClientError,
       req?: ServiceClientRequestOptions
     ) => void;
   };

diff --git a/lib/request.ts b/lib/request.ts
@@ -81,7 +81,7 @@ export class ServiceClientResponse {
   constructor(
     public statusCode: number,
     public headers: IncomingHttpHeaders,
-    public body: Buffer | string | object,
+    public body: Buffer | string | object | object[],
     public request: ServiceClientRequestOptions
   ) {
     this.retryErrors = [];

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "perron",
-  "version": "0.11.4",
+  "version": "0.11.5",
   "description": "A sane client for web services",
   "engines": {
     "node": ">=12.0.0"