1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: edit Stream api grammar

Browse Source 
Sections:
  - Introduction
  - Orginization of this Document
  - Object Mode
  - Buffering
  - API for Stream Implementers

PR-URL: https://github.com/nodejs/node/pull/9100
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
This commit is contained in:
Benji Marinacci 2016-10-14 12:27:14 -07:00 committed by James M Snell
parent cb87748023
commit 3c4349e8a2
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/api/stream.md
View File

@ -19,14 +19,14 @@ The `stream` module can be accessed using:
const stream = require('stream'); const stream = require('stream');
``` ```
While it is important for all Node.js users to understand how streams works, While it is important for all Node.js users to understand how streams work,
the `stream` module itself is most useful for developers that are creating new the `stream` module itself is most useful for developers that are creating new
types of stream instances. Developer's who are primarily *consuming* stream types of stream instances. Developer's who are primarily *consuming* stream
objects will rarely (if ever) have need to use the `stream` module directly. objects will rarely (if ever) have need to use the `stream` module directly.
## Organization of this document ## Organization of this Document
This document is divided into two primary sections and third section for This document is divided into two primary sections with a third section for
additional notes. The first section explains the elements of the stream API that additional notes. The first section explains the elements of the stream API that
are required to *use* streams within an application. The second section explains are required to *use* streams within an application. The second section explains
the elements of the API that are required to *implement* new types of streams. the elements of the API that are required to *implement* new types of streams.
@ -48,7 +48,7 @@ There are four fundamental stream types within Node.js:
All streams created by Node.js APIs operate exclusively on strings and `Buffer` All streams created by Node.js APIs operate exclusively on strings and `Buffer`
objects. It is possible, however, for stream implementations to work with other objects. It is possible, however, for stream implementations to work with other
types of JavaScript values (with the exception of `null` which serves a special types of JavaScript values (with the exception of `null`, which serves a special
purpose within streams). Such streams are considered to operate in "object purpose within streams). Such streams are considered to operate in "object
mode". mode".
@ -87,7 +87,7 @@ total size of the internal write buffer is below the threshold set by
the size of the internal buffer reaches or exceeds the `highWaterMark`, `false` the size of the internal buffer reaches or exceeds the `highWaterMark`, `false`
will be returned. will be returned.
A key goal of the `stream` API, and in particular the [`stream.pipe()`] method, A key goal of the `stream` API, particularly the [`stream.pipe()`] method,
is to limit the buffering of data to acceptable levels such that sources and is to limit the buffering of data to acceptable levels such that sources and
destinations of differing speeds will not overwhelm the available memory. destinations of differing speeds will not overwhelm the available memory.
@ -98,8 +98,8 @@ appropriate and efficient flow of data. For example, [`net.Socket`][] instances
are [Duplex][] streams whose Readable side allows consumption of data received are [Duplex][] streams whose Readable side allows consumption of data received
*from* the socket and whose Writable side allows writing data *to* the socket. *from* the socket and whose Writable side allows writing data *to* the socket.
Because data may be written to the socket at a faster or slower rate than data Because data may be written to the socket at a faster or slower rate than data
is received, it is important each side operate (and buffer) independently of is received, it is important for each side to operate (and buffer) independently
the other. of the other.
## API for Stream Consumers ## API for Stream Consumers
@ -1061,7 +1061,7 @@ Examples of Transform streams include:
<!--type=misc--> <!--type=misc-->
The `stream` module API has been designed to make it possible to easily The `stream` module API has been designed to make it possible to easily
implement streams using JavaScript's prototypical inheritance model. implement streams using JavaScript's prototypal inheritance model.
First, a stream developer would declare a new JavaScript class that extends one First, a stream developer would declare a new JavaScript class that extends one
of the four basic stream classes (`stream.Writable`, `stream.Readable`, of the four basic stream classes (`stream.Writable`, `stream.Readable`,