Skip to content

stream: add compose operator #44937

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 7 commits into from
Oct 31, 2022
Merged

stream: add compose operator #44937

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
076bbe5
stream: add compose operator
rluvaton Oct 9, 2022
da9255f
stream: rename import
rluvaton Oct 9, 2022
273b0b6
stream: add abort signal support
rluvaton Oct 9, 2022
2e4898e
stream: add validation and refactor tests
rluvaton Oct 26, 2022
fed2ac3
stream: fix lint and add started adding docs
rluvaton Oct 26, 2022
da244b9
stream: added an example in the streams docs
rluvaton Oct 27, 2022
7e55077
stream: fix lint error
rluvaton Oct 29, 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
Prev Previous commit
Next Next commit
stream: fix lint and add started adding docs
  • Loading branch information
@rluvaton
rluvaton committed Oct 26, 2022
commit fed2ac3613c3a65361014bdc23c7ed604941e2f0
19 changes: 19 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1681,6 +1681,25 @@ option. In the code example above, data will be in a single chunk if the file
has less then 64 KiB of data because no `highWaterMark` option is provided to
[`fs.createReadStream()`][].

##### `readable.compose(stream[, options])`

<!-- YAML
added:
-->

Comment thread
rluvaton marked this conversation as resolved.
> Stability: 1 - Experimental

* `stream` {Stream|Iterable|AsyncIterable|Function}
* `options` {Object}
* `signal` {AbortSignal} allows destroying the stream if the signal is
aborted.
* Returns: {Duplex} a stream composed with the stream `stream`.



See [`stream.compose`][] for more information.

@benjamingr benjamingr Oct 27, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add an example please?

@rluvaton rluvaton Oct 27, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added 👍🏻



##### `readable.iterator([options])`

<!-- YAML
Expand Down
4 changes: 2 additions & 2 deletions test/parallel/test-stream-compose-operator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,12 @@ const assert = require('assert');
assert.throws(
() => Readable.from(['a']).compose(Readable.from(['b'])),
{ code: 'ERR_INVALID_ARG_VALUE' }
)
);
}

{
assert.throws(
() => Readable.from(['a']).compose(),
{ code: 'ERR_INVALID_ARG_TYPE' }
)
);
}
6 changes: 3 additions & 3 deletions test/parallel/test-stream-compose.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,21 +361,21 @@ const assert = require('assert');
assert.throws(
Comment thread
benjamingr marked this conversation as resolved.
() => compose(),
{ code: 'ERR_MISSING_ARGS' }
)
);
}

{
assert.throws(
() => compose(new Writable(), new PassThrough()),
{ code: 'ERR_INVALID_ARG_VALUE' }
)
);
}

{
assert.throws(
() => compose(new PassThrough(), new Readable({ read() {} }), new PassThrough()),
{ code: 'ERR_INVALID_ARG_VALUE' }
)
);
}

{
Expand Down