@naturalcycles/js-lib 14.76.0 → 14.77.0

package/dist/promise/pRetry.d.ts

@@ -1,5 +1,10 @@
-import { CommonLogger } from '..';
+import { AnyFunction, CommonLogger } from '..';
 export interface PRetryOptions {
+    /**
+     * If set - will be included in the error message.
+     * Can be used to identify the place in the code that failed.
+     */
+    name?: string;
     /**
      * How many attempts to try.
      * First attempt is not a retry, but "initial try". It still counts.
@@ -62,4 +67,4 @@ export interface PRetryOptions {
  * Returns a Function (!), enhanced with retry capabilities.
  * Implements "Exponential back-off strategy" by multiplying the delay by `delayMultiplier` with each try.
  */
-export declare function pRetry<T extends Function>(fn: T, opt?: PRetryOptions): T;
+export declare function pRetry<T extends AnyFunction>(fn: T, opt?: PRetryOptions): T;

package/dist/promise/pRetry.js

@@ -8,7 +8,7 @@ const __1 = require("..");
  */
 // eslint-disable-next-line @typescript-eslint/ban-types
 function pRetry(fn, opt = {}) {
-    const { maxAttempts = 4, delay: initialDelay = 1000, delayMultiplier = 2, predicate, logger = console, } = opt;
+    const { maxAttempts = 4, delay: initialDelay = 1000, delayMultiplier = 2, predicate, logger = console, name = fn.name, } = opt;
     let { logFirstAttempt = false, logRetries = true, logFailures = false, logSuccess = false } = opt;
     if (opt.logAll) {
         logFirstAttempt = logRetries = logFailures = true;
@@ -16,7 +16,7 @@ function pRetry(fn, opt = {}) {
     if (opt.logNone) {
         logSuccess = logFirstAttempt = logRetries = logFailures = false;
     }
-    const fname = ['pRetry', fn.name].filter(Boolean).join('.');
+    const fname = ['pRetry', name].filter(Boolean).join('.');
     return async function (...args) {
         let delay = initialDelay;
         let attempt = 0;
@@ -36,9 +36,9 @@ function pRetry(fn, opt = {}) {
                 }
                 catch (err) {
                     if (logFailures) {
-                        logger.warn(`${fname} attempt #${attempt} error in ${(0, __1._since)(started)}:\n${(0, __1._stringifyAny)(err, {
+                        logger.warn(`${fname} attempt #${attempt} error in ${(0, __1._since)(started)}:`, (0, __1._stringifyAny)(err, {
                             includeErrorData: true,
-                        })}`);
+                        }));
                     }
                     if (attempt >= maxAttempts || (predicate && !predicate(err, attempt, maxAttempts))) {
                         // Give up

package/dist-esm/promise/pRetry.js

@@ -5,7 +5,7 @@ import { _since, _stringifyAny } from '..';
  */
 // eslint-disable-next-line @typescript-eslint/ban-types
 export function pRetry(fn, opt = {}) {
-    const { maxAttempts = 4, delay: initialDelay = 1000, delayMultiplier = 2, predicate, logger = console, } = opt;
+    const { maxAttempts = 4, delay: initialDelay = 1000, delayMultiplier = 2, predicate, logger = console, name = fn.name, } = opt;
     let { logFirstAttempt = false, logRetries = true, logFailures = false, logSuccess = false } = opt;
     if (opt.logAll) {
         logFirstAttempt = logRetries = logFailures = true;
@@ -13,7 +13,7 @@ export function pRetry(fn, opt = {}) {
     if (opt.logNone) {
         logSuccess = logFirstAttempt = logRetries = logFailures = false;
     }
-    const fname = ['pRetry', fn.name].filter(Boolean).join('.');
+    const fname = ['pRetry', name].filter(Boolean).join('.');
     return async function (...args) {
         let delay = initialDelay;
         let attempt = 0;
@@ -33,9 +33,9 @@ export function pRetry(fn, opt = {}) {
                 }
                 catch (err) {
                     if (logFailures) {
-                        logger.warn(`${fname} attempt #${attempt} error in ${_since(started)}:\n${_stringifyAny(err, {
+                        logger.warn(`${fname} attempt #${attempt} error in ${_since(started)}:`, _stringifyAny(err, {
                             includeErrorData: true,
-                        })}`);
+                        }));
                     }
                     if (attempt >= maxAttempts || (predicate && !predicate(err, attempt, maxAttempts))) {
                         // Give up

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.76.0",
+  "version": "14.77.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/promise/pRetry.ts

@@ -1,6 +1,12 @@
-import { _since, _stringifyAny, CommonLogger } from '..'
+import { _since, _stringifyAny, AnyFunction, CommonLogger } from '..'
 
 export interface PRetryOptions {
+  /**
+   * If set - will be included in the error message.
+   * Can be used to identify the place in the code that failed.
+   */
+  name?: string
+
   /**
    * How many attempts to try.
    * First attempt is not a retry, but "initial try". It still counts.
@@ -75,13 +81,14 @@ export interface PRetryOptions {
  * Implements "Exponential back-off strategy" by multiplying the delay by `delayMultiplier` with each try.
  */
 // eslint-disable-next-line @typescript-eslint/ban-types
-export function pRetry<T extends Function>(fn: T, opt: PRetryOptions = {}): T {
+export function pRetry<T extends AnyFunction>(fn: T, opt: PRetryOptions = {}): T {
   const {
     maxAttempts = 4,
     delay: initialDelay = 1000,
     delayMultiplier = 2,
     predicate,
     logger = console,
+    name = fn.name,
   } = opt
 
   let { logFirstAttempt = false, logRetries = true, logFailures = false, logSuccess = false } = opt
@@ -93,7 +100,7 @@ export function pRetry<T extends Function>(fn: T, opt: PRetryOptions = {}): T {
     logSuccess = logFirstAttempt = logRetries = logFailures = false
   }
 
-  const fname = ['pRetry', fn.name].filter(Boolean).join('.')
+  const fname = ['pRetry', name].filter(Boolean).join('.')
 
   return async function (this: any, ...args: any[]) {
     let delay = initialDelay
@@ -118,9 +125,10 @@ export function pRetry<T extends Function>(fn: T, opt: PRetryOptions = {}): T {
         } catch (err) {
           if (logFailures) {
             logger.warn(
-              `${fname} attempt #${attempt} error in ${_since(started)}:\n${_stringifyAny(err, {
+              `${fname} attempt #${attempt} error in ${_since(started)}:`,
+              _stringifyAny(err, {
                 includeErrorData: true,
-              })}`,
+              }),
             )
           }