@ezez/utils 4.7.2 → 4.8.1

package/src/formatHash.ts

@@ -0,0 +1,24 @@
+const DEFAULT_SIDE_CHARS_LENGTH = 4;
+
+/**
+ * Formats given input string, taking first `sideCharsLength` and last `sideCharsLength` characters,
+ * joining them with `separator`. If there is not enough characters, returns the original string.
+ * @param hash
+ * @param sideCharsLength
+ * @param separator
+ * @example formatHash("abcdef1234567890") // "abcd…7890"
+ */
+const formatHash = (hash: string, sideCharsLength: number = DEFAULT_SIDE_CHARS_LENGTH, separator = "…"): string => {
+    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+    if (hash.length <= sideCharsLength * 2) {
+        return hash;
+    }
+    const start = hash.slice(0, sideCharsLength);
+    const end = hash.slice(-sideCharsLength);
+    return `${start}${separator}${end}`;
+};
+
+export {
+    formatHash,
+};
+

package/src/getMultiple.ts

@@ -28,7 +28,7 @@ const DEFAULT = {};
  * // will return 5
  * @returns {*} - found value or default value
  */
-const getMultiple = (source: Source, defaultValue: unknown, ...paths: (string | string[])[]): unknown => {
+const getMultiple = (source: Source, defaultValue: unknown, ...paths: Array<string | string[]>): unknown => {
     const length = paths.length;
     for (let i = 0; i < length; i++) {
         const properties = paths[i]!;

package/src/ignore.spec.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import must from "must";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy";
 import { ignore } from "./ignore";
 import { wait } from "./wait";

package/src/index.ts

@@ -16,6 +16,7 @@ export * from "./ensureError.js";
 export * from "./ensureTimestamp.js";
 export * from "./escapeRegExp.js";
 export * from "./formatDate.js";
+export * from "./formatHash.js";
 export * from "./get.js";
 export * from "./getMultiple.js";
 export * from "./hasProps.js";

package/src/insertSeparator.ts

@@ -5,14 +5,14 @@
  * @param {*} separator - separator to inset
  * @returns {Array} - new array with separator items added or same array if there isn't enough items to put separator
  */
-const insertSeparator = <T, S>(source: T[], separator: S): (T | S)[] => {
+const insertSeparator = <T, S>(source: T[], separator: S): Array<T | S> => {
     if (!Array.isArray(source)) {
         throw new TypeError("Source must be an array");
     }
     if (source.length <= 1) {
         return source;
     }
-    const result: (T | S)[] = [...source];
+    const result: Array<T | S> = [...source];
     for (let i = result.length - 1; i > 0; i--) {
         result.splice(i, 0, separator);
     }

package/src/mapValues.ts

@@ -35,7 +35,7 @@ type MapValuesFn<S, R> = (value: S[keyof S], key: keyof S) => R;
 const mapValues = <SourceObject extends Record<string, unknown>, PossibleReturnValues>(
     source: SourceObject, fn: MapValuesFn<SourceObject, PossibleReturnValues>,
 ): { [P in keyof SourceObject]: PossibleReturnValues } => {
-    const keys = Object.keys(source) as (keyof SourceObject)[];
+    const keys = Object.keys(source) as Array<keyof SourceObject>;
 
     // @ts-expect-error TypeScript doesn't work well with this type with reduce
     // @TODO check with ts 5+ or something

package/src/memoize.spec.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import must from "must";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy";
 import { memoize } from "./memoize";
 

package/src/remove.spec.ts

@@ -1,6 +1,6 @@
 import { remove as _remove } from "lodash";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy.js";
 import { remove } from "./remove.js";
 

package/src/safe.ts

@@ -15,7 +15,7 @@ function safe<T, Y>(fn: () => T, def?: Y): T | (Y extends undefined ? undefined
         return fn();
     }
     catch {
-        // @ts-ignore ts can't do conditional returns in runtime
+        // @ts-expect-error ts can't do conditional returns in runtime
         return def;
     }
 }

package/src/sample.ts

@@ -1,8 +1,8 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 type IsTuple<T> = T extends readonly [infer A, ...(infer B)] ? true : false;
 type MaybeTupleReturn<T> = IsTuple<T> extends true
-    ? (T extends readonly (infer U)[] ? U : never)
-    : (T extends (infer U)[] ? U | undefined : never);
+    ? (T extends ReadonlyArray<infer U> ? U : never)
+    : (T extends Array<infer U> ? U | undefined : never);
 
 /**
  * Picks a random element from an array.

package/src/seq.ts

@@ -15,7 +15,7 @@ type Fn<T> = () => T;
  *
  * @see {@link seq}
  */
-type Functions<T> = Fn<T>[] | [Fn<T>[]];
+type Functions<T> = Array<Fn<T>> | [Array<Fn<T>>];
 
 /**
  * A function that decides if the sequential run should be early stopped.
@@ -25,7 +25,7 @@ type Functions<T> = Fn<T>[] | [Fn<T>[]];
  */
 type EarlyBreaker = (e: unknown) => boolean;
 
-const run = <T>(list: Fn<T>[], earlyBreaker?: EarlyBreaker): Promise<T> => {
+const run = <T>(list: Array<Fn<T>>, earlyBreaker?: EarlyBreaker): Promise<T> => {
     if (!list.length) {
         return fail();
     }
@@ -81,7 +81,7 @@ const seqEarlyBreak = <T>(earlyBreaker: EarlyBreaker | undefined, ...args: Funct
     if (args.length === 1) {
         return run(Array.isArray(args[0]) ? args[0] : [args[0]], earlyBreaker);
     }
-    return run(args as Fn<T>[], earlyBreaker);
+    return run(args as Array<Fn<T>>, earlyBreaker);
 };
 
 /**

package/src/serializeToBuffer/unserializeFromBuffer.spec.ts

@@ -60,4 +60,14 @@ describe("unserialize", () => {
             0x35, 0x6a, 0x00, 0x22, 0x6e, 0x3a, 0x31, 0x22, 0x00,
         ]))).eql([1]);
     });
+
+    it("unserializes multiple various arguments", async () => {
+        must(unserialize(Buffer.from([
+            0x35, 0x66, 0x00, 0x70, 0x69, 0x6e, 0x67, 0x32, 0x00,
+            0x35, 0x6a, 0x00, 0x22, 0x6e, 0x3a, 0x35, 0x22, 0x00,
+            0x35, 0x6a, 0x00, 0x22, 0x62, 0x3a, 0x31, 0x22, 0x00,
+            0x35, 0x6a, 0x00, 0x22, 0x6e, 0x3a, 0x36, 0x22, 0x00,
+            0x35, 0x6a, 0x00, 0x22, 0x6e, 0x3a, 0x39, 0x22, 0x00,
+        ]))).eql(["ping2", 5, true, 6, 9]);
+    });
 });

package/src/serializeToBuffer/unserializeFromBuffer.ts

@@ -1,8 +1,6 @@
 import { deserialize } from "../deserialize.js";
 import { BINARY_MARK_BIN, BINARY_MARK_MAP, BINARY_MARK_STRING } from "./const.js";
 
-const MAX_DATA_PARTS = 4;
-
 const NOT_FOUND = -1;
 const LAST_CHAR = -1;
 
@@ -29,8 +27,7 @@ const unserializeFromBuffer = <RT extends any[] = unknown[]>( // eslint-disable-
     let startPoint = 0;
     const result = [];
 
-    let i = 0;
-    while (i++ < MAX_DATA_PARTS) {
+    while (startPoint < intData.length) {
         const dataSplitPoint = intData.indexOf(0, startPoint); // find null
         if (dataSplitPoint === NOT_FOUND) { // no null found = no data
             break;

package/src/setImmutable.ts

@@ -30,7 +30,7 @@ const hasOnlyValidPathParts = (array: unknown[]) => {
  * Path to store value in. Can be a dot-separated string or an array of strings.
  * Numbers are allowed for convenience.
  */
-type Path = number | string | (number | string)[];
+type Path = number | string | Array<number | string>;
 
 const getPathParts = (path: Path) => {
     if (typeof path === "number") {

package/src/sortByMultiple.ts

@@ -30,7 +30,7 @@
 const sortByMultiple = <
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     T extends Record<string | number | symbol, any>,
-    K extends (keyof T)[],
+    K extends Array<keyof T>,
 >(
     propertyNames: K,
     ascending: boolean | Record<K[number], boolean> = true,

package/src/waitFor.spec.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import must from "must";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy";
 import { wait } from "./wait";
 import { waitFor } from "./waitFor";
@@ -91,8 +91,7 @@ describe("waitFor", () => {
 
     it("crashes if check function crashes", async () => {
         await waitFor(() => {
-            // @ts-ignore
-            throw new Error(5);
+            throw new Error("5");
         }, { interval: 40 }).then(() => {
             throw new Error("Should not resolve");
         }, (e: unknown) => {