Skip to content

docs,test: add tests and docs for duplex.fromWeb and duplex.toWeb #42738

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.

Sign up for GitHub

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

Merged
nodejs-github-bot merged 5 commits into from
Apr 28, 2022
Merged

docs,test: add tests and docs for duplex.fromWeb and duplex.toWeb #42738

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3a1c6ae
doc,test: add tests and docs for duplex.fromWeb and duplex.toWeb
ErickWendel Apr 14, 2022
d248554
all small nits suggestions
ErickWendel Apr 15, 2022
c7f95ff
add example in cjs to enable toggle docs
ErickWendel Apr 18, 2022
d5d117e
Update doc/api/stream.md
ErickWendel Apr 20, 2022
6e2967e
docs: apply suggestions from code review
ErickWendel Apr 20, 2022
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
54 changes: 54 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2874,6 +2874,38 @@ added: v17.0.0
* `signal` {AbortSignal}
* Returns: {stream.Duplex}

```mjs
import { Duplex } from 'stream';
Comment thread
ErickWendel marked this conversation as resolved.
Outdated
import {
ReadableStream,
WritableStream
} from 'stream/web';
Comment thread
ErickWendel marked this conversation as resolved.
Outdated

const readable = new ReadableStream({
start(controller) {
controller.enqueue('world');
},
});

const writable = new WritableStream({
write(chunk) {
console.log('writable', chunk);
}
});

const pair = {
readable,
writable
};
const duplex = Duplex.fromWeb(pair, { encoding: 'utf8', objectMode: true });

duplex.write('hello');

for await (const chunk of duplex) {
console.log('readable', chunk);
}
```

### `stream.Duplex.toWeb(streamDuplex)`

<!-- YAML
Expand All @@ -2887,6 +2919,28 @@ added: v17.0.0
* `readable` {ReadableStream}
* `writable` {WritableStream}

```mjs
import { Duplex } from 'stream';
Comment thread
ErickWendel marked this conversation as resolved.
Outdated

const duplex = Duplex({
objectMode: true,
read() {
this.push('world');
this.push(null);
},
write(chunk, encoding, callback) {
console.log('writable', chunk);
callback();
}
});

const { readable, writable } = Duplex.toWeb(duplex);
writable.getWriter().write('hello');

const { value } = await readable.getReader().read();
console.log('readable', value);
```

### `stream.addAbortSignal(signal, stream)`

<!-- YAML
Expand Down
80 changes: 79 additions & 1 deletion test/parallel/test-stream-duplex.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
// USE OR OTHER DEALINGS IN THE SOFTWARE.
'use strict';

require('../common');
const common = require('../common');
const assert = require('assert');
const Duplex = require('stream').Duplex;
const { ReadableStream, WritableStream } = require('stream/web');

const stream = new Duplex({ objectMode: true });

Expand Down Expand Up @@ -53,3 +54,80 @@ process.on('exit', () => {
assert.strictEqual(read.val, 1);
assert.strictEqual(written.val, 2);
});

// Duplex.fromWeb
{
const dataToRead = Buffer.from('hello');
const dataToWrite = Buffer.from('world');

const readable = new ReadableStream({
start(controller) {
controller.enqueue(dataToRead);
},
});

const writable = new WritableStream({
write: common.mustCall((chunk) => {
assert.strictEqual(chunk, dataToWrite);
})
});

const pair = { readable, writable };
const duplex = Duplex.fromWeb(pair);

duplex.write(dataToWrite);
duplex.once('data', common.mustCall((chunk) => {
assert.strictEqual(chunk, dataToRead);
}));
}

// Duplex.fromWeb - using utf8 and objectMode
{
const dataToRead = 'hello';
const dataToWrite = 'world';

const readable = new ReadableStream({
start(controller) {
controller.enqueue(dataToRead);
},
});

const writable = new WritableStream({
write: common.mustCall((chunk) => {
assert.strictEqual(chunk, dataToWrite);
})
});

const pair = {
readable,
writable
};
Comment thread
ErickWendel marked this conversation as resolved.
const duplex = Duplex.fromWeb(pair, { encoding: 'utf8', objectMode: true });

duplex.write(dataToWrite);
duplex.once('data', common.mustCall((chunk) => {
assert.strictEqual(chunk, dataToRead);
}));
}
// Duplex.toWeb
{
const dataToRead = Buffer.from('hello');
const dataToWrite = Buffer.from('world');

const duplex = Duplex({
read() {
this.push(dataToRead);
this.push(null);
},
write: common.mustCall((chunk) => {
assert.strictEqual(chunk, dataToWrite);
})
});

const { writable, readable } = Duplex.toWeb(duplex);
writable.getWriter().write(dataToWrite);

readable.getReader().read().then(common.mustCall((result) => {
assert.deepStrictEqual(Buffer.from(result.value), dataToRead);
}));
}