@augment-vir/common 30.5.1 → 30.6.1

package/dist/augments/array/create-array.d.ts

@@ -0,0 +1,30 @@
+import type { Tuple } from '@augment-vir/core';
+/**
+ * Creates an array of size `size` and calls the given `callback` for each entry in the array and
+ * fills the array with the results. The returned array is typed to exactly fit the given size.
+ *
+ * This function automatically awaits async callbacks.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {createArray} from '@augment-vir/common';
+ *
+ * const result = createArray(5, (index) => {
+ *     return `hi ${index}`;
+ * });
+ * // result is `['hi 0', 'hi 1', 'hi 2', 'hi 3', 'hi 4']`
+ *
+ * const asyncResult = await createArray(5, async (index) => {
+ *     return Promise.resolve(`hi ${index}`);
+ * });
+ * // result is `['hi 0', 'hi 1', 'hi 2', 'hi 3', 'hi 4']`
+ * ```
+ *
+ * @returns A new array filled with the results of the given `callback` typed as a Tuple,
+ *   automatically wrapping the return type in a `Promise` if the callback returns one.
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function createArray<Size extends number, T>(size: Size, callback: (index: number) => T): Extract<T, Promise<any>> extends never ? Tuple<T, Size> : Promise<Tuple<Awaited<T>, Size>>;

package/dist/augments/array/create-array.js

@@ -0,0 +1,41 @@
+import { check } from '@augment-vir/assert';
+/**
+ * Creates an array of size `size` and calls the given `callback` for each entry in the array and
+ * fills the array with the results. The returned array is typed to exactly fit the given size.
+ *
+ * This function automatically awaits async callbacks.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {createArray} from '@augment-vir/common';
+ *
+ * const result = createArray(5, (index) => {
+ *     return `hi ${index}`;
+ * });
+ * // result is `['hi 0', 'hi 1', 'hi 2', 'hi 3', 'hi 4']`
+ *
+ * const asyncResult = await createArray(5, async (index) => {
+ *     return Promise.resolve(`hi ${index}`);
+ * });
+ * // result is `['hi 0', 'hi 1', 'hi 2', 'hi 3', 'hi 4']`
+ * ```
+ *
+ * @returns A new array filled with the results of the given `callback` typed as a Tuple,
+ *   automatically wrapping the return type in a `Promise` if the callback returns one.
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function createArray(size, callback) {
+    const array = [];
+    let gotPromise = false;
+    for (let i = 0; i < size; i++) {
+        const result = callback(i);
+        if (check.isPromise(result)) {
+            gotPromise = true;
+        }
+        array.push(result);
+    }
+    return (gotPromise ? Promise.all(array) : array);
+}

package/dist/augments/number/clamp.d.ts

@@ -1,4 +1,4 @@
-import { MinMax } from './min-max.js';
+import { MinMax } from '@augment-vir/core';
 /**
  * Clamp's the given value to within the min and max bounds, inclusive.
  *

package/dist/augments/number/wrap-number.d.ts

@@ -1,7 +1,7 @@
-import { MinMax } from './min-max.js';
+import { MinMax } from '@augment-vir/core';
 /**
  * If the given value is outside the given min/max bounds, instead of clamping the number (as the
- * {@link clamp} function does), this function wraps the value around to the next bound (inclusive).
+ * `clamp` function does), this function wraps the value around to the next bound (inclusive).
  *
  * @category Number
  * @category Package : @augment-vir/common

package/dist/augments/number/wrap-number.js

@@ -1,7 +1,7 @@
-import { ensureMinMax } from './min-max.js';
+import { ensureMinMax } from '@augment-vir/core';
 /**
  * If the given value is outside the given min/max bounds, instead of clamping the number (as the
- * {@link clamp} function does), this function wraps the value around to the next bound (inclusive).
+ * `clamp` function does), this function wraps the value around to the next bound (inclusive).
  *
  * @category Number
  * @category Package : @augment-vir/common

package/dist/augments/random/random-integer.js

@@ -1,4 +1,4 @@
-import { ensureMinMax } from '../number/min-max.js';
+import { ensureMinMax } from '@augment-vir/core';
 /**
  * Creates a random integer (no decimal points are included) between the given min and max values
  * (inclusive).

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './augments/array/array-to-object.js';
 export * from './augments/array/awaited/awaited-filter.js';
 export * from './augments/array/awaited/awaited-for-each.js';
 export * from './augments/array/awaited/awaited-map.js';
+export * from './augments/array/create-array.js';
 export * from './augments/array/filter.js';
 export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/repeat-array.js';
@@ -29,7 +30,6 @@ export * from './augments/number/clamp.js';
 export * from './augments/number/coords.js';
 export * from './augments/number/digit.js';
 export * from './augments/number/dimensions.js';
-export * from './augments/number/min-max.js';
 export * from './augments/number/number-conversion.js';
 export * from './augments/number/round.js';
 export * from './augments/number/scientific.js';

package/dist/index.js

@@ -3,6 +3,7 @@ export * from './augments/array/array-to-object.js';
 export * from './augments/array/awaited/awaited-filter.js';
 export * from './augments/array/awaited/awaited-for-each.js';
 export * from './augments/array/awaited/awaited-map.js';
+export * from './augments/array/create-array.js';
 export * from './augments/array/filter.js';
 export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/repeat-array.js';
@@ -29,7 +30,6 @@ export * from './augments/number/clamp.js';
 export * from './augments/number/coords.js';
 export * from './augments/number/digit.js';
 export * from './augments/number/dimensions.js';
-export * from './augments/number/min-max.js';
 export * from './augments/number/number-conversion.js';
 export * from './augments/number/round.js';
 export * from './augments/number/scientific.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "30.5.1",
+    "version": "30.6.1",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -39,8 +39,8 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.5.1",
-        "@augment-vir/core": "^30.5.1",
+        "@augment-vir/assert": "^30.6.1",
+        "@augment-vir/core": "^30.6.1",
         "@date-vir/duration": "^6.0.1",
         "ansi-styles": "^6.2.1",
         "json5": "^2.2.3",

package/dist/augments/number/min-max.d.ts

@@ -1,18 +0,0 @@
-/**
- * @category Number
- * @category Package : @augment-vir/common
- * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
- */
-export type MinMax = {
-    min: number;
-    max: number;
-};
-/**
- * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
- * that is not the case, values are swapped.
- *
- * @category Number
- * @category Package : @augment-vir/common
- * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
- */
-export declare function ensureMinMax({ min, max }: MinMax): MinMax;

package/dist/augments/number/min-max.js

@@ -1,16 +0,0 @@
-/**
- * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
- * that is not the case, values are swapped.
- *
- * @category Number
- * @category Package : @augment-vir/common
- * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
- */
-export function ensureMinMax({ min, max }) {
-    if (min > max) {
-        return { min: max, max: min };
-    }
-    else {
-        return { min, max };
-    }
-}