Skip to content

Commit 0380a55

Browse files
Trotttargos
authored andcommitted
doc: edit stream module introduction
Edit the stream module introduction for concision and simplicity. PR-URL: #28595 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent ccb54f7 commit 0380a55

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

doc/api/stream.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
> Stability: 2 - Stable
66
77
A stream is an abstract interface for working with streaming data in Node.js.
8-
The `stream` module provides a base API that makes it easy to build objects
9-
that implement the stream interface.
8+
The `stream` module provides an API for implementing the stream interface.
109

1110
There are many stream objects provided by Node.js. For instance, a
1211
[request to an HTTP server][http-incoming-message] and [`process.stdout`][]
@@ -15,16 +14,14 @@ are both stream instances.
1514
Streams can be readable, writable, or both. All streams are instances of
1615
[`EventEmitter`][].
1716

18-
The `stream` module can be accessed using:
17+
To access the `stream` module:
1918

2019
```js
2120
const stream = require('stream');
2221
```
2322

24-
While it is important to understand how streams work, the `stream` module itself
25-
is most useful for developers that are creating new types of stream instances.
26-
Developers who are primarily *consuming* stream objects will rarely need to use
27-
the `stream` module directly.
23+
The `stream` module is useful for creating new types of stream instances. It is
24+
usually not necessary to use the `stream` module to consume streams.
2825

2926
## Organization of this Document
3027

0 commit comments

Comments
 (0)