Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix async iterable pipeline AbortSignal examples #42258

Merged
merged 2 commits into from
Mar 14, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: fix async iterable pipeline signal examples
Fix the pipeline examples to show that async generators receive
an AbortSignal wrapped in an object.
tilgovi authored Mar 8, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit b05ac87368b7693012c0e0bc98c4fb2eaf47cd2b
4 changes: 2 additions & 2 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
@@ -2532,7 +2532,7 @@ const fs = require('fs');
async function run() {
await pipeline(
fs.createReadStream('lowercase.txt'),
async function* (source, signal) {
async function* (source, { signal }) {
source.setEncoding('utf8'); // Work with strings rather than `Buffer`s.
for await (const chunk of source) {
yield await processChunk(chunk, { signal });
@@ -2556,7 +2556,7 @@ const fs = require('fs');

async function run() {
await pipeline(
async function * (signal) {
async function * ({ signal }) {
await someLongRunningfn({ signal });
yield 'asd';
},