Skip to content

Commit 4822cb4

Browse files
committed
polish: rename mapAsyncIterator to mapAsyncIterable
...as the function maps iterables (by extracting the iterator).
1 parent a12a6bd commit 4822cb4

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

src/execution/__tests__/mapAsyncIterator-test.ts renamed to src/execution/__tests__/mapAsyncIterable-test.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
import { expect } from 'chai';
22
import { describe, it } from 'mocha';
33

4-
import { mapAsyncIterator } from '../mapAsyncIterator';
4+
import { mapAsyncIterable } from '../mapAsyncIterable';
55

66
/* eslint-disable @typescript-eslint/require-await */
7-
describe('mapAsyncIterator', () => {
7+
describe('mapAsyncIterable', () => {
88
it('maps over async generator', async () => {
99
async function* source() {
1010
yield 1;
1111
yield 2;
1212
yield 3;
1313
}
1414

15-
const doubles = mapAsyncIterator(source(), (x) => x + x);
15+
const doubles = mapAsyncIterable(source(), (x) => x + x);
1616

1717
expect(await doubles.next()).to.deep.equal({ value: 2, done: false });
1818
expect(await doubles.next()).to.deep.equal({ value: 4, done: false });
@@ -42,7 +42,7 @@ describe('mapAsyncIterator', () => {
4242
},
4343
};
4444

45-
const doubles = mapAsyncIterator(iterable, (x) => x + x);
45+
const doubles = mapAsyncIterable(iterable, (x) => x + x);
4646

4747
expect(await doubles.next()).to.deep.equal({ value: 2, done: false });
4848
expect(await doubles.next()).to.deep.equal({ value: 4, done: false });
@@ -60,7 +60,7 @@ describe('mapAsyncIterator', () => {
6060
yield 3;
6161
}
6262

63-
const doubles = mapAsyncIterator(source(), (x) => x + x);
63+
const doubles = mapAsyncIterable(source(), (x) => x + x);
6464

6565
const result = [];
6666
for await (const x of doubles) {
@@ -76,7 +76,7 @@ describe('mapAsyncIterator', () => {
7676
yield 3;
7777
}
7878

79-
const doubles = mapAsyncIterator(source(), (x) => Promise.resolve(x + x));
79+
const doubles = mapAsyncIterable(source(), (x) => Promise.resolve(x + x));
8080

8181
expect(await doubles.next()).to.deep.equal({ value: 2, done: false });
8282
expect(await doubles.next()).to.deep.equal({ value: 4, done: false });
@@ -100,7 +100,7 @@ describe('mapAsyncIterator', () => {
100100
}
101101
}
102102

103-
const doubles = mapAsyncIterator(source(), (x) => x + x);
103+
const doubles = mapAsyncIterable(source(), (x) => x + x);
104104

105105
expect(await doubles.next()).to.deep.equal({ value: 2, done: false });
106106
expect(await doubles.next()).to.deep.equal({ value: 4, done: false });
@@ -139,7 +139,7 @@ describe('mapAsyncIterator', () => {
139139
},
140140
};
141141

142-
const doubles = mapAsyncIterator(iterable, (x) => x + x);
142+
const doubles = mapAsyncIterable(iterable, (x) => x + x);
143143

144144
expect(await doubles.next()).to.deep.equal({ value: 2, done: false });
145145
expect(await doubles.next()).to.deep.equal({ value: 4, done: false });
@@ -164,7 +164,7 @@ describe('mapAsyncIterator', () => {
164164
}
165165
}
166166

167-
const doubles = mapAsyncIterator(source(), (x) => x + x);
167+
const doubles = mapAsyncIterable(source(), (x) => x + x);
168168

169169
expect(await doubles.next()).to.deep.equal({ value: 'aa', done: false });
170170
expect(await doubles.next()).to.deep.equal({ value: 'bb', done: false });
@@ -203,7 +203,7 @@ describe('mapAsyncIterator', () => {
203203
},
204204
};
205205

206-
const doubles = mapAsyncIterator(iterable, (x) => x + x);
206+
const doubles = mapAsyncIterable(iterable, (x) => x + x);
207207

208208
expect(await doubles.next()).to.deep.equal({ value: 2, done: false });
209209
expect(await doubles.next()).to.deep.equal({ value: 4, done: false });
@@ -231,7 +231,7 @@ describe('mapAsyncIterator', () => {
231231
}
232232
}
233233

234-
const doubles = mapAsyncIterator(source(), (x) => x + x);
234+
const doubles = mapAsyncIterable(source(), (x) => x + x);
235235

236236
expect(await doubles.next()).to.deep.equal({ value: 2, done: false });
237237
expect(await doubles.next()).to.deep.equal({ value: 4, done: false });
@@ -258,7 +258,7 @@ describe('mapAsyncIterator', () => {
258258
throw new Error('Goodbye');
259259
}
260260

261-
const doubles = mapAsyncIterator(source(), (x) => x + x);
261+
const doubles = mapAsyncIterable(source(), (x) => x + x);
262262

263263
expect(await doubles.next()).to.deep.equal({
264264
value: 'HelloHello',
@@ -293,7 +293,7 @@ describe('mapAsyncIterator', () => {
293293
}
294294
}
295295

296-
const throwOver1 = mapAsyncIterator(source(), mapper);
296+
const throwOver1 = mapAsyncIterable(source(), mapper);
297297

298298
expect(await throwOver1.next()).to.deep.equal({ value: 1, done: false });
299299

src/execution/execute.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ import {
5151
collectFields,
5252
collectSubfields as _collectSubfields,
5353
} from './collectFields';
54-
import { mapAsyncIterator } from './mapAsyncIterator';
54+
import { mapAsyncIterable } from './mapAsyncIterable';
5555
import { getArgumentValues, getVariableValues } from './values';
5656

5757
/* eslint-disable max-params */
@@ -1143,7 +1143,7 @@ function mapSourceToResponse(
11431143
// the GraphQL specification. The `execute` function provides the
11441144
// "ExecuteSubscriptionEvent" algorithm, as it is nearly identical to the
11451145
// "ExecuteQuery" algorithm, for which `execute` is also used.
1146-
return mapAsyncIterator(resultOrStream, (payload: unknown) =>
1146+
return mapAsyncIterable(resultOrStream, (payload: unknown) =>
11471147
executeImpl(buildPerEventExecutionContext(exeContext, payload)),
11481148
);
11491149
}

src/execution/mapAsyncIterator.ts renamed to src/execution/mapAsyncIterable.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import type { PromiseOrValue } from '../jsutils/PromiseOrValue';
44
* Given an AsyncIterable and a callback function, return an AsyncIterator
55
* which produces values mapped via calling the callback function.
66
*/
7-
export function mapAsyncIterator<T, U, R = undefined>(
7+
export function mapAsyncIterable<T, U, R = undefined>(
88
iterable: AsyncGenerator<T, R, void> | AsyncIterable<T>,
99
callback: (value: T) => PromiseOrValue<U>,
1010
): AsyncGenerator<U, R, void> {

0 commit comments

Comments
 (0)