@augment-vir/common 31.43.3 → 31.44.0

package/README.md

@@ -5,7 +5,6 @@ A collection of augments, helpers types, functions, and classes for any JavaScri
 -   Examples: [`filterObject`](https://electrovir.github.io/augment-vir/functions/filterObject.html), [`wait`](https://electrovir.github.io/augment-vir/functions/wait.html), [`getEnumValues`](https://electrovir.github.io/augment-vir/functions/getEnumValues.html)
 -   Includes a colored logger implementation: [`log`](https://electrovir.github.io/augment-vir/variables/log.html)
 -   Includes a SQL-select-like runtime implementation of TypeScript's `Pick`: [`selectFrom`](https://electrovir.github.io/augment-vir/functions/selectFrom-1.html)
--   Includes Prisma type helpers.
 -   and much more...
 
 See all `@augment-vir` docs here: https://electrovir.github.io/augment-vir

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

@@ -15,6 +15,7 @@ export type ArrayPaginationOptions = {
  * `getPage` is `0` indexed.
  *
  * @category Array
+ * @category Package : @augment-vir/common
  * @example
  *
  * ```ts
@@ -51,6 +52,7 @@ export type ChunkArrayOptions = RequireExactlyOne<{
  * Split an array into multiple sub array "chunks" based on the given options.
  *
  * @category Array
+ * @category Package : @augment-vir/common
  * @example
  *
  * ```ts

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

@@ -3,6 +3,7 @@
  * `getPage` is `0` indexed.
  *
  * @category Array
+ * @category Package : @augment-vir/common
  * @example
  *
  * ```ts
@@ -30,6 +31,7 @@ export function getArrayPage(originalArray, options) {
  * Split an array into multiple sub array "chunks" based on the given options.
  *
  * @category Array
+ * @category Package : @augment-vir/common
  * @example
  *
  * ```ts

package/dist/augments/array/from-async-iterable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Convert an async iterator or async iterable into an array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ */
+export declare function fromAsyncIterable<T>(asyncInput: AsyncIterable<T> | AsyncIterator<T>): Promise<T[]>;

package/dist/augments/array/from-async-iterable.js

@@ -0,0 +1,34 @@
+/**
+ * Convert an async iterator or async iterable into an array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ */
+export async function fromAsyncIterable(asyncInput) {
+    const collapsed = [];
+    if (isAsyncIterable(asyncInput)) {
+        for await (const entry of asyncInput) {
+            collapsed.push(entry);
+        }
+        return collapsed;
+    }
+    else if (isAsyncIterator(asyncInput)) {
+        for (;;) {
+            const { value, done } = await asyncInput.next();
+            if (done) {
+                break;
+            }
+            collapsed.push(value);
+        }
+        return collapsed;
+    }
+    else {
+        throw new TypeError('Input is neither AsyncIterable nor AsyncIterator.');
+    }
+}
+function isAsyncIterable(value) {
+    return typeof value[Symbol.asyncIterator] === 'function';
+}
+function isAsyncIterator(value) {
+    return typeof value.next === 'function';
+}

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export * from './augments/array/cross-product.js';
 export * from './augments/array/ensure-array.js';
 export * from './augments/array/extract-duplicates.js';
 export * from './augments/array/filter.js';
+export * from './augments/array/from-async-iterable.js';
 export * from './augments/array/repeat-array.js';
 export * from './augments/array/shuffle-array.js';
 export * from './augments/array/string-array.js';

package/dist/index.js

@@ -10,6 +10,7 @@ export * from './augments/array/cross-product.js';
 export * from './augments/array/ensure-array.js';
 export * from './augments/array/extract-duplicates.js';
 export * from './augments/array/filter.js';
+export * from './augments/array/from-async-iterable.js';
 export * from './augments/array/repeat-array.js';
 export * from './augments/array/shuffle-array.js';
 export * from './augments/array/string-array.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.43.3",
+    "version": "31.44.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.43.3",
-        "@augment-vir/core": "^31.43.3",
+        "@augment-vir/assert": "^31.44.0",
+        "@augment-vir/core": "^31.44.0",
         "@date-vir/duration": "^8.0.0",
         "ansi-styles": "^6.2.3",
         "deepcopy-esm": "^2.1.1",