Skip to content
Permalink
Browse files

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>
  • Loading branch information...
Trott authored and targos committed Jul 8, 2019
1 parent ccb54f7 commit 0380a558afeff5d9d099e0c17c977145fbae8c18
Showing with 4 additions and 7 deletions.
  1. +4 −7 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

0 comments on commit 0380a55

Please sign in to comment.
You can’t perform that action at this time.