Accept async iterable as input (#8)

sindresorhus · Dec 27, 2023 · 2723855 · 2723855
1 parent def9865
commit 2723855
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 17 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -74,7 +74,9 @@ for await (const element of pFilterIterable(places, filterer)) {
 ```
 */
 export function pFilterIterable<ValueType>(
-	input: Iterable<ValueType | PromiseLike<ValueType>>,
+	input:
+	| AsyncIterable<ValueType | PromiseLike<ValueType>>
+	| Iterable<ValueType | PromiseLike<ValueType>>,
 	filterer: (
 		element: ValueType,
 		index: number

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -22,6 +22,18 @@ expectType<AsyncIterable<string>>(
 	),
 );
 
+async function * getPlaces(): AsyncIterable<string> {
+	yield 'Bangkok, Thailand';
+	yield 'Berlin, Germany';
+	yield 'Tokyo, Japan';
+}
+
+expectType<AsyncIterable<string>>(
+	pFilterIterable(getPlaces(), async place =>
+		place === 'Bangkok, Thailand' ? true : Promise.resolve(false),
+	),
+);
+
 expectType<AsyncIterable<number>>(
 	pFilterIterable(new Set([1, 2]), number => number > 1, {concurrency: 1}),
 );
diff --git a/package.json b/package.json
@@ -41,11 +41,11 @@
 		"parallel"
 	],
 	"dependencies": {
-		"p-map": "^7.0.0"
+		"p-map": "^7.0.1"
 	},
 	"devDependencies": {
 		"ava": "^6.0.1",
-		"tsd": "^0.30.0",
+		"tsd": "^0.30.1",
 		"xo": "^0.56.0"
 	}
 }
diff --git a/test.js b/test.js
@@ -18,6 +18,15 @@ test('handles empty iterable', async t => {
 });
 
 test('pFilterIterable', async t => {
+	const iterableToArray = async iterable => {
+		const array = [];
+		for await (const item of iterable) {
+			array.push(item);
+		}
+
+		return array;
+	};
+
 	const rangeIterable = {
 		async * [Symbol.asyncIterator]() {
 			yield 1;
@@ -26,21 +35,29 @@ test('pFilterIterable', async t => {
 			yield 4;
 		},
 	};
-	const iterable = pFilterIterable(rangeIterable, x => x % 2);
-	const results = [];
-	for await (const x of iterable) {
-		results.push(x);
-	}
-
-	t.deepEqual(results, [1, 3]);
+	t.deepEqual(
+		await iterableToArray(pFilterIterable(rangeIterable, x => x % 2)),
+		[1, 3],
+	);
 
-	const iterable2 = pFilterIterable(rangeIterable, x =>
-		Promise.resolve(x % 2),
+	t.deepEqual(
+		await iterableToArray(
+			pFilterIterable(rangeIterable, x => Promise.resolve(x % 2)),
+		),
+		[1, 3],
 	);
-	const results2 = [];
-	for await (const x of iterable2) {
-		results2.push(x);
-	}
 
-	t.deepEqual(results2, [1, 3]);
+	t.deepEqual(
+		await iterableToArray(
+			pFilterIterable([Promise.resolve(1), 2, 3, 4], x => x % 2),
+		),
+		[1, 3],
+	);
+	t.deepEqual(
+		await iterableToArray(
+			pFilterIterable([1, 2, 3, 4], x => Promise.resolve(x % 2)),
+		),
+		[1, 3],
+	);
+	t.deepEqual(await iterableToArray(pFilterIterable([])), []);
 });