@mimik/request-retry 4.0.5 → 4.0.6

package/README.md

@@ -17,7 +17,7 @@ Make a request with retries.
 **Throws**:
 
 - <code>Error</code> An error produced by `getRichError`, wrapping an error from
-  [request-promise](https://www.npmjs.com/package/request-promise) or a `TimeoutError`.
+[request-promise](https://www.npmjs.com/package/request-promise) or a `TimeoutError`.
 
 The following properties may be added to the `options` object under the `retry` property:
 - retries `{int}`: Maximum number of retries, independent of the `retryStrategy`. Default: `2`.
@@ -71,5 +71,5 @@ To ease migration from `request-promise`, the following adjustments are applied
 
 | Param | Type | Description |
 | --- | --- | --- |
-| options | <code>object</code> | Options for the request (similar to [axios](https://www.npmjs.com/package/axios)).   The `validateStatus` option is disabled: an error is thrown for status codes outside **[200, 300)**.   An additional option, `resolveWithFullResponse`, controls the return shape:   when `true`, the full Axios response object is returned; when `false` or omitted, only `response.data` is returned. |
+| options | <code>object</code> | Options for the request (similar to [axios](https://www.npmjs.com/package/axios)). The `validateStatus` option is disabled: an error is thrown for status codes outside **[200, 300)**. An additional option, `resolveWithFullResponse`, controls the return shape: when `true`, the full Axios response object is returned; when `false` or omitted, only `response.data` is returned. |
 

package/index.js

@@ -48,13 +48,13 @@ Promise.config({ cancellation: true });
  * @requires @mimik/response-helper
  * @category async
  * @param {object} options - Options for the request (similar to [axios](https://www.npmjs.com/package/axios)).
- *   The `validateStatus` option is disabled: an error is thrown for status codes outside **[200, 300)**.
- *   An additional option, `resolveWithFullResponse`, controls the return shape:
- *   when `true`, the full Axios response object is returned; when `false` or omitted, only `response.data` is returned.
+ * The `validateStatus` option is disabled: an error is thrown for status codes outside **[200, 300)**.
+ * An additional option, `resolveWithFullResponse`, controls the return shape:
+ * when `true`, the full Axios response object is returned; when `false` or omitted, only `response.data` is returned.
  * @return {Promise}
  * @fulfil {object} - The Axios response when `resolveWithFullResponse` is `true`; otherwise `response.data`.
  * @throws {Error} An error produced by `getRichError`, wrapping an error from
- *   [request-promise](https://www.npmjs.com/package/request-promise) or a `TimeoutError`.
+ * [request-promise](https://www.npmjs.com/package/request-promise) or a `TimeoutError`.
  *
  * The following properties may be added to the `options` object under the `retry` property:
  * - retries `{int}`: Maximum number of retries, independent of the `retryStrategy`. Default: `2`.

package/manual-test/testEnv.js

@@ -10,7 +10,7 @@ import process from 'process';
  * | SUMO_LOGIC_COLLECTOR_CODE | code to use to log on sumologic | null
  * | NO_STACK | flag to have a stack associated with the log | yes
  * | LOG_LEVEL | log level to log | error
- * | CONSOLE_LEVEL | log level to diplay | debug
+ * | CONSOLE_LEVEL | log level to display | debug
  * | LOG_MODE | log mode | none
  */
 /*

package/manual-test/testRetry.js

@@ -26,12 +26,12 @@ const options = {
    * delayStrategy: 'joe', // => setDelay returning retryDelay
    * delayStrategy: function badDelay() { return 'joe' }, // => no change then bad delay strategy => retryDelay
    * delayStrategy: function userDelay(...args) { return (Math.pow(2, args[0]) * 100) + Math.floor(Math.random() * 50) }, // OK
-   * retryStrategy: 'joe', // => unknowRetry returning false
+   * retryStrategy: 'joe', // => unknownRetry returning false
    * retryStrategy: function badRetry() { return 'joe' }, // => no change then bad retry strategy => false
    * retryStrategy: function userRetry(...args) { // OK
    *   const { statusCode } = args[1]; // err
    *
-   *   return statusCode && (Math.floor(statusCode/100) !== 5 || statusCode !== 429); // retry if there is no statusCode or if there is 500 range statucCode or 429
+   *   return statusCode && (Math.floor(statusCode/100) !== 5 || statusCode !== 429); // retry if there is no statusCode or if there is 500 range statusCode or 429
    * },
    * retryStrategy: function invalidRetry(...args) { // defaultRetry
    *   const { statusCode } = args[34]; // null value

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/request-retry",
-  "version": "4.0.5",
+  "version": "4.0.6",
   "description": "Request retry wrapping axios",
   "main": "./index.js",
   "type": "module",
@@ -31,25 +31,25 @@
   "dependencies": {
     "@mimik/request-helper": "^2.0.2",
     "@mimik/response-helper": "^4.0.6",
-    "@mimik/sumologic-winston-logger": "^2.1.6",
+    "@mimik/sumologic-winston-logger": "^2.1.8",
     "axios": "1.12.2",
     "bluebird": "3.7.2"
   },
   "devDependencies": {
-    "@eslint/js": "9.35.0",
+    "@eslint/js": "9.36.0",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.3.1",
+    "@stylistic/eslint-plugin": "5.4.0",
     "acorn": "8.15.0",
     "body-parser": "2.2.0",
     "c8": "10.1.3",
     "chai": "6.0.1",
-    "eslint": "9.35.0",
+    "eslint": "9.36.0",
     "eslint-plugin-import": "2.32.0",
     "express": "5.1.0",
     "husky": "9.1.7",
     "jsdoc-to-markdown": "9.1.2",
     "mocha": "11.7.2",
-    "mochawesome": "7.1.3",
+    "mochawesome": "7.1.4",
     "sinon": "21.0.0"
   }
 }

package/test/testEnv.js

@@ -10,7 +10,7 @@ import process from 'node:process';
  * | SUMO_LOGIC_COLLECTOR_CODE | code to use to log on sumologic | null
  * | NO_STACK | flag to have a stack associated with the log | yes
  * | LOG_LEVEL | log level to log | error
- * | CONSOLE_LEVEL | log level to diplay | debug
+ * | CONSOLE_LEVEL | log level to display | debug
  * | LOG_MODE | log mode | none
  */