@augment-vir/common 31.33.1 → 31.34.0

package/dist/augments/array/awaited/awaited-find.d.ts

@@ -0,0 +1,32 @@
+import { type MaybePromise } from '@augment-vir/core';
+/**
+ * Performs
+ * [`[].find()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/find)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedFind` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedFind} from '@augment-vir/common';
+ *
+ * await awaitedFind(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         await Promise.resolve(value > 2);
+ *     },
+ * );
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function awaitedFind<const T>(array: ReadonlyArray<T>, callback: (item: T, index: number, originalArray: ReadonlyArray<T>) => MaybePromise<boolean>): Promise<T | undefined>;

package/dist/augments/array/awaited/awaited-find.js

@@ -0,0 +1,39 @@
+/**
+ * Performs
+ * [`[].find()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/find)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedFind` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedFind} from '@augment-vir/common';
+ *
+ * await awaitedFind(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         await Promise.resolve(value > 2);
+ *     },
+ * );
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export async function awaitedFind(array, callback) {
+    for (let index = 0; index < array.length; index++) {
+        const item = array[index];
+        if (await callback(item, index, array)) {
+            return item;
+        }
+    }
+    return undefined;
+}

package/dist/augments/string/substring-index.js

@@ -12,7 +12,6 @@ export function findSubstringIndexes({ searchIn, searchFor, caseSensitive, inclu
     const searchRegExp = addRegExpFlags(setRegExpCaseSensitivity(searchFor, { caseSensitive }), 'g');
     const indexes = [];
     const indexesAndLengths = [];
-    // eslint-disable-next-line sonarjs/no-ignored-return
     searchIn.replace(searchRegExp, (...matchResults) => {
         /**
          * Grabbing the second to last entry in the array (rather than the second) takes capture

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './augments/array/array-map.js';
 export * from './augments/array/array-pagination.js';
 export * from './augments/array/array-to-object.js';
 export * from './augments/array/awaited/awaited-filter.js';
+export * from './augments/array/awaited/awaited-find.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';

package/dist/index.js

@@ -2,6 +2,7 @@ export * from './augments/array/array-map.js';
 export * from './augments/array/array-pagination.js';
 export * from './augments/array/array-to-object.js';
 export * from './augments/array/awaited/awaited-filter.js';
+export * from './augments/array/awaited/awaited-find.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';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.33.1",
+    "version": "31.34.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.33.1",
-        "@augment-vir/core": "^31.33.1",
+        "@augment-vir/assert": "^31.34.0",
+        "@augment-vir/core": "^31.34.0",
         "@date-vir/duration": "^7.4.2",
         "ansi-styles": "^6.2.1",
         "deepcopy-esm": "^2.1.1",