From 86f8f4f7912eb7a97bd7b7b10d634c7ecaca1387 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 7 Jul 2019 22:15:01 -0700 Subject: [PATCH] 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 Reviewed-By: Luigi Pinca Reviewed-By: Yongsheng Zhang Reviewed-By: Ruben Bridgewater Reviewed-By: Trivikram Kamat --- doc/api/stream.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 471a0cdda49942..6f43d83fc31fa4 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