Skip to content
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

Jump to bottom

doc: edit stream module introduction #28595

Merged
merged 1 commit into from
Jul 12, 2019
Merged

doc: edit stream module introduction #28595

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`][]
Expand All @@ -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

Expand Down