🚧 progress: First draft.

Author: make-github-pseudonymous-again

README.md

@@ -4,13 +4,17 @@
 AsyncIterable to Array conversion for JavaScript.
 See [docs](https://async-iterable-iterator.github.io/async-iterable-to-array/index.html).
 
-> :building_construction: Caveat emptor! This is work in progress. Code may be
-> working. Documentation may be present. Coherence may be. Maybe.
-
 > :warning: Depending on your environment, the code may require
 > `regeneratorRuntime` to be defined, for instance by importing
 > [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
 
+```js
+import {asyncIterableToArray} from '@async-iterable-iterator/async-iterable-to-array';
+
+let asyncIterable = ...;
+let array = await asyncIterableToArray(asyncIterable);
+```
+
 [![License](https://img.shields.io/github/license/async-iterable-iterator/async-iterable-to-array.svg)](https://raw.githubusercontent.com/async-iterable-iterator/async-iterable-to-array/main/LICENSE)
 [![Version](https://img.shields.io/npm/v/@async-iterable-iterator/async-iterable-to-array.svg)](https://www.npmjs.org/package/@async-iterable-iterator/async-iterable-to-array)
 [![Tests](https://img.shields.io/github/workflow/status/async-iterable-iterator/async-iterable-to-array/ci:cover?event=push&label=tests)](https://github.com/async-iterable-iterator/async-iterable-to-array/actions/workflows/ci:cover.yml?query=branch:main)

doc/scripts/header.js

@@ -17,7 +17,8 @@ domReady(() => {
 	header.insertBefore(projectname, header.firstChild);
 
 	const testlink = document.querySelector('header > a[data-ice="testLink"]');
-	testlink.href = 'https://app.codecov.io/gh/async-iterable-iterator/async-iterable-to-array';
+	testlink.href =
+		'https://app.codecov.io/gh/async-iterable-iterator/async-iterable-to-array';
 	testlink.target = '_BLANK';
 
 	const searchBox = document.querySelector('.search-box');

package.json

@@ -63,7 +63,9 @@
     "release": "np --message ':hatching_chick: release: Bumping to v%s.'",
     "test": "ava"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@async-iterable-iterator/async-iterator-to-array": "^0.0.1"
+  },
   "devDependencies": {
     "@babel/core": "7.16.5",
     "@babel/preset-env": "7.16.5",

src/index.js

@@ -1,2 +1,6 @@
-const answer = 42;
-export default answer;
+import {asyncIteratorToArray} from '@async-iterable-iterator/async-iterator-to-array';
+
+export const asyncIterableToArray = async (asyncIterable) => {
+	const asyncIterator = asyncIterable[Symbol.asyncIterator]();
+	return asyncIteratorToArray(asyncIterator);
+};

test/src/api.js

@@ -0,0 +1,20 @@
+import test from 'ava';
+
+import {asyncIterableToArray} from '../../src/index.js';
+
+const asyncify = async function* (array) {
+	// eslint-disable-next-line no-await-in-loop
+	for (const x of array) yield await x;
+};
+
+const macro = async (t, expected) => {
+	const asyncIterable = asyncify(expected);
+	const actual = await asyncIterableToArray(asyncIterable);
+	t.deepEqual(actual, expected);
+};
+
+macro.title = (title, expected) => title ?? JSON.stringify(expected);
+
+test(macro, [1, 2, 3]);
+test(macro, [1, Math.random(), 3]);
+test(macro, [1, Math.random(), 3]);