xjs-common 8.2.0 → 8.3.1

package/README.md

@@ -1,4 +1,4 @@
-[![CI](https://github.com/begyyal/xjs_commons/actions/workflows/test.yml/badge.svg)](https://github.com/begyyal/xjs_commons/actions/workflows/test.yml)
+[![npm][npm-badge]][npm-url] [![CI][ci-badge]][ci-url]
 
 # Overview
 Library modules for nodejs + typescript that bundled general-purpose implementations.  
@@ -13,7 +13,7 @@ npm i xjs-common
 # Code example (only part)
  - Miscellaneous utilities.
 ```ts
-import { checkPortAvailability, delay, int2array, UFile, UHttp } from "xjs-common";
+import { checkPortAvailability, delay, int2array, UFile, UHttp, retry } from "xjs-common";
 
 (async () => {
     // await 3 seconds.
@@ -33,13 +33,12 @@ import { checkPortAvailability, delay, int2array, UFile, UHttp } from "xjs-commo
     // p1=a&p2=1&p2=2
     console.log(UHttp.concatParamsWithEncoding(null, { p1: "a", p2: ["1", "2"] }));
 
+    // runs callback with customizable retry.
+    retry(async () => { }, { count: 2 });
+
     // concatenate file path and make directory if doesn't already exist.
     UFile.mkdir("path/to/dir");
     UFile.mkdir(["path", "to", "dir"]);
-
-    // ignore if f1 is not file or doesn't exist.
-    UFile.mv("path/to/f1", "path/to/f2");
-    UFile.mv(["path", "to", "f1"], ["path", "to", "f2"]);
 })();
 ```
  - Array utilities.
@@ -76,8 +75,6 @@ import { UArray } from "xjs-common";
 import { UString } from "xjs-common";
 
 (() => {
-    // true
-    console.log(UString.eq("", "   "));
     // false
     console.log(UString.eq("", null));
     // true
@@ -91,9 +88,10 @@ import { UString } from "xjs-common";
     // AA
     console.log(UString.idx2az(26));
 
-    // e.g. 20250310
-    console.log(UString.simpleDate2day());
-    console.log(UString.simpleDate2day(new Date()));
+    // e.g. 20250615053513
+    console.log(UString.simpleTime());
+    // e.g. 20250615
+    console.log(UString.simpleTime({ date: getJSTDate(), unit: TimeUnit.Day }));
 })();
 ```
  - Http client enhanced for web scraping.
@@ -221,3 +219,8 @@ XJS throws error with `code` property which has one of the following numbers.
 
 # License
 [Apache-License](./LICENSE)
+
+[npm-url]: https://npmjs.org/package/xjs-common
+[npm-badge]: https://badgen.net/npm/v/xjs-common
+[ci-url]: https://github.com/begyyal/xjs_commons/actions/workflows/test.yml
+[ci-badge]: https://github.com/begyyal/xjs_commons/actions/workflows/test.yml/badge.svg

package/dist/func/u-array.d.ts

@@ -5,7 +5,7 @@ export declare namespace UArray {
      * @param v1 it uses equal operator for comparing elements, so applying object element is not recommended.
      * @param v2 same as v1.
      * @param sort it uses {@link Array#sort} on v1 and v2 if true. default is true.
-     * @param useStrictEqual it uses === operator for compareing elements if true, otherwise using == operator. default is true.
+     * @param useStrictEqual it uses `===` operator for compareing elements if true, otherwise using `==` operator. default is true.
      */
     function eq(v1: any[], v2: any[], op: {
         sort?: boolean;

package/dist/func/u-file.d.ts

@@ -9,5 +9,5 @@ export declare namespace UFile {
     function read(p: MaybeArray<string>, encoding: BufferEncoding): string;
     function cp(from: MaybeArray<string>, to: MaybeArray<string>): void;
     function mv(from: MaybeArray<string>, to: MaybeArray<string>): void;
-    function joinPath(p: MaybeArray<string>): string;
+    function joinPath(...p: MaybeArray<string>[]): string;
 }

package/dist/func/u-file.js

@@ -74,8 +74,8 @@ var UFile;
         fs.renameSync(f, t);
     }
     UFile.mv = mv;
-    function joinPath(p) {
-        return u_type_1.UType.isString(p) ? p : path.join(...p);
+    function joinPath(...p) {
+        return path.join(...p.flatMap(u_type_1.UType.takeAsArray));
     }
     UFile.joinPath = joinPath;
 })(UFile = exports.UFile || (exports.UFile = {}));

package/dist/func/u.d.ts

@@ -5,5 +5,22 @@ export declare function int2array(size: number): number[];
 export declare function array2map<K, T>(array: T[], keyGen: (e: T) => K): Map<K, T[]>;
 export declare function bitor(...bit: number[]): number;
 export declare function checkPortAvailability(port: number): Promise<boolean>;
-export declare function retry<T>(cb: () => T, count?: number, logger?: Loggable): T;
-export declare function retry<T>(cb: () => Promise<T>, count?: number, logger?: Loggable): Promise<T>;
+interface RetryOption<T = void | Promise<void>> {
+    count?: number;
+    logger?: Loggable;
+    errorCriterion?: (e: any) => boolean;
+    intervalPredicate?: () => T;
+}
+/**
+ * runs callback with customizable retry.
+ * @param cb callback to be retried.
+ * @param op.count number of retries. default is 1.
+ * @param op.logger logger used for exceptions while retrying the process. default is `console` object.
+ * @param op.errorCriterion distinguish whether retry is required form exceptions. default is none. (i.e. allways required.)
+ * @param op.intervalPredicate predicate that runs between callbacks when retrying.
+ */
+export declare function retry<T>(cb: () => T, op?: RetryOption<void>): T;
+export declare function retry<T>(cb: () => T, op?: RetryOption<Promise<void>>): Promise<T>;
+export declare function retry<T>(cb: () => Promise<T>, op?: RetryOption<void>): Promise<T>;
+export declare function retry<T>(cb: () => Promise<T>, op?: RetryOption<Promise<void>>): Promise<T>;
+export {};

package/dist/func/u.js

@@ -43,24 +43,43 @@ function checkPortAvailability(port) {
     });
 }
 exports.checkPortAvailability = checkPortAvailability;
-function retry(cb, count = 2, logger = console) {
+;
+function retry(cb, op) {
+    const l = op?.logger ?? console;
+    const initialCount = op?.count ?? 1;
+    const handleError = (e) => {
+        if (op?.errorCriterion && !op.errorCriterion(e))
+            return false;
+        l.warn(e);
+        return true;
+    };
     const prcs = (c) => {
         if (c < 0)
             throw new xjs_err_1.XjsErr(s_errCode, "failure exceeds retryable count.");
         let ret = null;
-        try {
-            ret = cb();
-        }
-        catch (e) {
-            logger.warn(e);
-            ret = prcs(c - 1);
-        }
-        if (ret instanceof Promise) {
-            return new Promise(resolve => ret.then(resolve).catch(e => { logger.warn(e); resolve(prcs(c - 1)); }));
-        }
-        else
-            return ret;
+        const innerPrcs = () => {
+            try {
+                ret = cb();
+            }
+            catch (e) {
+                if (handleError(e))
+                    ret = prcs(c - 1);
+                else
+                    throw e;
+            }
+            if (ret instanceof Promise) {
+                return new Promise((resolve, reject) => ret.then(resolve).catch((e) => { if (handleError(e))
+                    resolve(prcs(c - 1));
+                else
+                    reject(e); }));
+            }
+            else
+                return ret;
+        };
+        if (c < initialCount && op?.intervalPredicate)
+            ret = op?.intervalPredicate();
+        return ret instanceof Promise ? ret.then(() => innerPrcs()) : innerPrcs();
     };
-    return prcs(count);
+    return prcs(initialCount);
 }
 exports.retry = retry;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xjs-common",
-  "version": "8.2.0",
+  "version": "8.3.1",
   "description": "library modules for nodejs + typescript that bundled general-purpose implementations.",
   "repository": {
     "type": "git",