summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2019-07-07 22:15:01 -0700
committerMichaƫl Zasso <targos@protonmail.com>2019-07-20 11:10:21 +0200
commit0380a558afeff5d9d099e0c17c977145fbae8c18 (patch)
treee8acb42e6d835236c27e16f6cad9a4dad8bc5439 /doc
parentccb54f7a84fe64a739f3519ab2a995510641c011 (diff)
downloadandroid-node-v8-0380a558afeff5d9d099e0c17c977145fbae8c18.tar.gz
android-node-v8-0380a558afeff5d9d099e0c17c977145fbae8c18.tar.bz2
android-node-v8-0380a558afeff5d9d099e0c17c977145fbae8c18.zip
doc: edit stream module introduction
Edit the stream module introduction for concision and simplicity. PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/stream.md11
1 files changed, 4 insertions, 7 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 471a0cdda4..6f43d83fc3 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -5,8 +5,7 @@
> Stability: 2 - Stable
A stream is an abstract interface for working with streaming data in Node.js.
-The `stream` module provides a base API that makes it easy to build objects
-that implement the stream interface.
+The `stream` module provides an API for implementing the stream interface.
There are many stream objects provided by Node.js. For instance, a
[request to an HTTP server][http-incoming-message] and [`process.stdout`][]
@@ -15,16 +14,14 @@ are both stream instances.
Streams can be readable, writable, or both. All streams are instances of
[`EventEmitter`][].
-The `stream` module can be accessed using:
+To access the `stream` module:
```js
const stream = require('stream');
```
-While it is important to understand how streams work, the `stream` module itself
-is most useful for developers that are creating new types of stream instances.
-Developers who are primarily *consuming* stream objects will rarely need to use
-the `stream` module directly.
+The `stream` module is useful for creating new types of stream instances. It is
+usually not necessary to use the `stream` module to consume streams.
## Organization of this Document