@augment-vir/common 31.60.0 → 31.62.0

package/dist/augments/function/execute-count.d.ts

@@ -0,0 +1,17 @@
+import { type MaybePromise, type Tuple } from '@augment-vir/core';
+/**
+ * Executes the given callback a given count of times.
+ *
+ * @category Function
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {executeCount} from '@augment-vir/common';
+ *
+ * executeCount(5, (count) => console.log(count)); // will log: 1,2,3,4,5
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function executeCount<N extends number, T = void | undefined>(count: N, callback: (currentCount: number, totalCount: number) => T): Extract<T, Promise<any>> extends never ? Tuple<T, N> : Exclude<T, Promise<any>> extends never ? Promise<Tuple<Awaited<T>, N>> : MaybePromise<Tuple<Awaited<T>, N>>;

package/dist/augments/function/execute-count.js

@@ -0,0 +1,40 @@
+import { createArray } from '../array/create-array.js';
+/**
+ * Executes the given callback a given count of times.
+ *
+ * @category Function
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {executeCount} from '@augment-vir/common';
+ *
+ * executeCount(5, (count) => console.log(count)); // will log: 1,2,3,4,5
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function executeCount(count, callback) {
+    return createArray(count, (index) => index + 1).reduce((accum, currentCount) => {
+        if (accum instanceof Promise) {
+            return accum.then(async (awaitedAccum) => {
+                const result = await callback(currentCount, count);
+                awaitedAccum.push(result);
+                return awaitedAccum;
+            });
+        }
+        else {
+            const result = callback(currentCount, count);
+            if (result instanceof Promise) {
+                return result.then((awaitedResult) => {
+                    accum.push(awaitedResult);
+                    return accum;
+                });
+            }
+            else {
+                accum.push(result);
+                return accum;
+            }
+        }
+    }, []);
+}

package/dist/augments/object/flatten-object.d.ts

@@ -0,0 +1,15 @@
+import { type AnyObject, type UnknownObject } from '@augment-vir/core';
+/**
+ * Flattens a nested object into a single-level object.
+ *
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {flattenObject} from '@augment-vir/common';
+ *
+ * flattenObject({a: 'hello', b: {c: 42, d: {e: true, a: 'bye'}}});
+ * // {a: 'bye', 'c': 42, 'e': true}
+ * ```
+ */
+export declare function flattenObject(originalObject: Readonly<AnyObject>): UnknownObject;

package/dist/augments/object/flatten-object.js

@@ -0,0 +1,32 @@
+import { check } from '@augment-vir/assert';
+/**
+ * Flattens a nested object into a single-level object.
+ *
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {flattenObject} from '@augment-vir/common';
+ *
+ * flattenObject({a: 'hello', b: {c: 42, d: {e: true, a: 'bye'}}});
+ * // {a: 'bye', 'c': 42, 'e': true}
+ * ```
+ */
+export function flattenObject(originalObject) {
+    return Object.fromEntries(flattenObjectToEntries(originalObject));
+}
+function flattenObjectToEntries(originalObject) {
+    return Object.entries(originalObject).flatMap(([key, value,]) => {
+        if (check.isObject(value)) {
+            return flattenObjectToEntries(value);
+        }
+        else {
+            return [
+                [
+                    key,
+                    value,
+                ],
+            ];
+        }
+    });
+}

package/dist/index.d.ts

@@ -19,6 +19,7 @@ export * from './augments/enum/enum-value-check.js';
 export * from './augments/error/combine-errors.js';
 export * from './augments/function/call-asynchronously.js';
 export * from './augments/function/debounce.js';
+export * from './augments/function/execute-count.js';
 export * from './augments/function/execution-duration.js';
 export * from './augments/function/if-truthy.js';
 export * from './augments/function/retry.js';
@@ -47,6 +48,7 @@ export * from './augments/object/deep-copy.js';
 export * from './augments/object/deep-value.js';
 export * from './augments/object/diff.js';
 export * from './augments/object/empty.js';
+export * from './augments/object/flatten-object.js';
 export * from './augments/object/get-or-set.js';
 export * from './augments/object/key-count.js';
 export * from './augments/object/map-entries.js';

package/dist/index.js

@@ -19,6 +19,7 @@ export * from './augments/enum/enum-value-check.js';
 export * from './augments/error/combine-errors.js';
 export * from './augments/function/call-asynchronously.js';
 export * from './augments/function/debounce.js';
+export * from './augments/function/execute-count.js';
 export * from './augments/function/execution-duration.js';
 export * from './augments/function/if-truthy.js';
 export * from './augments/function/retry.js';
@@ -47,6 +48,7 @@ export * from './augments/object/deep-copy.js';
 export * from './augments/object/deep-value.js';
 export * from './augments/object/diff.js';
 export * from './augments/object/empty.js';
+export * from './augments/object/flatten-object.js';
 export * from './augments/object/get-or-set.js';
 export * from './augments/object/key-count.js';
 export * from './augments/object/map-entries.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.60.0",
+    "version": "31.62.0",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -40,8 +40,8 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.60.0",
-        "@augment-vir/core": "^31.60.0",
+        "@augment-vir/assert": "^31.62.0",
+        "@augment-vir/core": "^31.62.0",
         "@date-vir/duration": "^8.1.0",
         "ansi-styles": "^6.2.3",
         "deepcopy-esm": "^2.1.1",