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

doc,stream: use code markup/markdown in headers

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Rich Trott 2019-12-24 15:09:29 -08:00
parent 85aed3e01e
commit 7034a3e68d
1 changed files with 69 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
doc/api/stream.md
View File

@ -206,14 +206,14 @@ myStream.write('some more data');
myStream.end('done writing data'); myStream.end('done writing data');
``` ```
#### Class: stream.Writable #### Class: `stream.Writable`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
<!--type=class--> <!--type=class-->
##### Event: 'close' ##### Event: `'close'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
changes: changes:
@ -230,7 +230,7 @@ that no more events will be emitted, and no further computation will occur.
A [`Writable`][] stream will always emit the `'close'` event if it is A [`Writable`][] stream will always emit the `'close'` event if it is
created with the `emitClose` option. created with the `emitClose` option.
##### Event: 'drain' ##### Event: `'drain'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -267,7 +267,7 @@ function writeOneMillionTimes(writer, data, encoding, callback) {
} }
``` ```
##### Event: 'error' ##### Event: `'error'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -284,7 +284,7 @@ stream.
After `'error'`, no further events other than `'close'` *should* be emitted After `'error'`, no further events other than `'close'` *should* be emitted
(including `'error'` events). (including `'error'` events).
##### Event: 'finish' ##### Event: `'finish'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -303,7 +303,7 @@ writer.on('finish', () => {
writer.end('This is the end\n'); writer.end('This is the end\n');
``` ```
##### Event: 'pipe' ##### Event: `'pipe'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -323,7 +323,7 @@ writer.on('pipe', (src) => {
reader.pipe(writer); reader.pipe(writer);
``` ```
##### Event: 'unpipe' ##### Event: `'unpipe'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -349,7 +349,7 @@ reader.pipe(writer);
reader.unpipe(writer); reader.unpipe(writer);
``` ```
##### writable.cork() ##### `writable.cork()`
<!-- YAML <!-- YAML
added: v0.11.2 added: v0.11.2
--> -->
@ -366,7 +366,7 @@ buffered writes in a more optimized manner.
See also: [`writable.uncork()`][]. See also: [`writable.uncork()`][].
##### writable.destroy(\[error\]) ##### `writable.destroy([error])`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -385,7 +385,7 @@ the `'drain'` event before destroying the stream.
Implementors should not override this method, Implementors should not override this method,
but instead implement [`writable._destroy()`][writable-_destroy]. but instead implement [`writable._destroy()`][writable-_destroy].
##### writable.destroyed ##### `writable.destroyed`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -394,7 +394,7 @@ added: v8.0.0
Is `true` after [`writable.destroy()`][writable-destroy] has been called. Is `true` after [`writable.destroy()`][writable-destroy] has been called.
##### writable.end(\[chunk\[, encoding\]\]\[, callback\]) ##### `writable.end([chunk[, encoding]][, callback])`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
changes: changes:
@ -432,7 +432,7 @@ file.end('world!');
// Writing more now is not allowed! // Writing more now is not allowed!
``` ```
##### writable.setDefaultEncoding(encoding) ##### `writable.setDefaultEncoding(encoding)`
<!-- YAML <!-- YAML
added: v0.11.15 added: v0.11.15
changes: changes:
@ -447,7 +447,7 @@ changes:
The `writable.setDefaultEncoding()` method sets the default `encoding` for a The `writable.setDefaultEncoding()` method sets the default `encoding` for a
[`Writable`][] stream. [`Writable`][] stream.
##### writable.uncork() ##### `writable.uncork()`
<!-- YAML <!-- YAML
added: v0.11.2 added: v0.11.2
--> -->
@ -485,7 +485,7 @@ process.nextTick(() => {
See also: [`writable.cork()`][]. See also: [`writable.cork()`][].
##### writable.writable ##### `writable.writable`
<!-- YAML <!-- YAML
added: v11.4.0 added: v11.4.0
--> -->
@ -494,7 +494,7 @@ added: v11.4.0
Is `true` if it is safe to call [`writable.write()`][stream-write]. Is `true` if it is safe to call [`writable.write()`][stream-write].
##### writable.writableEnded ##### `writable.writableEnded`
<!-- YAML <!-- YAML
added: v12.9.0 added: v12.9.0
--> -->
@ -505,7 +505,7 @@ Is `true` after [`writable.end()`][] has been called. This property
does not indicate whether the data has been flushed, for this use does not indicate whether the data has been flushed, for this use
[`writable.writableFinished`][] instead. [`writable.writableFinished`][] instead.
##### writable.writableCorked ##### `writable.writableCorked`
<!-- YAML <!-- YAML
added: v13.2.0 added: v13.2.0
--> -->
@ -515,7 +515,7 @@ added: v13.2.0
Number of times [`writable.uncork()`][stream-uncork] needs to be Number of times [`writable.uncork()`][stream-uncork] needs to be
called in order to fully uncork the stream. called in order to fully uncork the stream.
##### writable.writableFinished ##### `writable.writableFinished`
<!-- YAML <!-- YAML
added: v12.6.0 added: v12.6.0
--> -->
@ -524,7 +524,7 @@ added: v12.6.0
Is set to `true` immediately before the [`'finish'`][] event is emitted. Is set to `true` immediately before the [`'finish'`][] event is emitted.
##### writable.writableHighWaterMark ##### `writable.writableHighWaterMark`
<!-- YAML <!-- YAML
added: v9.3.0 added: v9.3.0
--> -->
@ -534,7 +534,7 @@ added: v9.3.0
Return the value of `highWaterMark` passed when constructing this Return the value of `highWaterMark` passed when constructing this
`Writable`. `Writable`.
##### writable.writableLength ##### `writable.writableLength`
<!-- YAML <!-- YAML
added: v9.4.0 added: v9.4.0
--> -->
@ -545,7 +545,7 @@ This property contains the number of bytes (or objects) in the queue
ready to be written. The value provides introspection data regarding ready to be written. The value provides introspection data regarding
the status of the `highWaterMark`. the status of the `highWaterMark`.
##### writable.writableObjectMode ##### `writable.writableObjectMode`
<!-- YAML <!-- YAML
added: v12.3.0 added: v12.3.0
--> -->
@ -554,7 +554,7 @@ added: v12.3.0
Getter for the property `objectMode` of a given `Writable` stream. Getter for the property `objectMode` of a given `Writable` stream.
##### writable.write(chunk\[, encoding\]\[, callback\]) ##### `writable.write(chunk[, encoding][, callback])`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
changes: changes:
@ -758,14 +758,14 @@ require more fine-grained control over the transfer and generation of data can
use the [`EventEmitter`][] and `readable.on('readable')`/`readable.read()` use the [`EventEmitter`][] and `readable.on('readable')`/`readable.read()`
or the `readable.pause()`/`readable.resume()` APIs. or the `readable.pause()`/`readable.resume()` APIs.
#### Class: stream.Readable #### Class: `stream.Readable`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
<!--type=class--> <!--type=class-->
##### Event: 'close' ##### Event: `'close'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
changes: changes:
@ -782,7 +782,7 @@ that no more events will be emitted, and no further computation will occur.
A [`Readable`][] stream will always emit the `'close'` event if it is A [`Readable`][] stream will always emit the `'close'` event if it is
created with the `emitClose` option. created with the `emitClose` option.
##### Event: 'data' ##### Event: `'data'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -815,7 +815,7 @@ readable.on('data', (chunk) => {
}); });
``` ```
##### Event: 'end' ##### Event: `'end'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -838,7 +838,7 @@ readable.on('end', () => {
}); });
``` ```
##### Event: 'error' ##### Event: `'error'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -852,7 +852,7 @@ to push an invalid chunk of data.
The listener callback will be passed a single `Error` object. The listener callback will be passed a single `Error` object.
##### Event: 'pause' ##### Event: `'pause'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -860,7 +860,7 @@ added: v0.9.4
The `'pause'` event is emitted when [`stream.pause()`][stream-pause] is called The `'pause'` event is emitted when [`stream.pause()`][stream-pause] is called
and `readableFlowing` is not `false`. and `readableFlowing` is not `false`.
##### Event: 'readable' ##### Event: `'readable'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
changes: changes:
@ -929,7 +929,7 @@ If there are `'data'` listeners when `'readable'` is removed, the stream
will start flowing, i.e. `'data'` events will be emitted without calling will start flowing, i.e. `'data'` events will be emitted without calling
`.resume()`. `.resume()`.
##### Event: 'resume' ##### Event: `'resume'`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -937,7 +937,7 @@ added: v0.9.4
The `'resume'` event is emitted when [`stream.resume()`][stream-resume] is The `'resume'` event is emitted when [`stream.resume()`][stream-resume] is
called and `readableFlowing` is not `true`. called and `readableFlowing` is not `true`.
##### readable.destroy(\[error\]) ##### `readable.destroy([error])`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -952,7 +952,7 @@ will be ignored.
Implementors should not override this method, but instead implement Implementors should not override this method, but instead implement
[`readable._destroy()`][readable-_destroy]. [`readable._destroy()`][readable-_destroy].
##### readable.destroyed ##### `readable.destroyed`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -961,7 +961,7 @@ added: v8.0.0
Is `true` after [`readable.destroy()`][readable-destroy] has been called. Is `true` after [`readable.destroy()`][readable-destroy] has been called.
##### readable.isPaused() ##### `readable.isPaused()`
<!-- YAML <!-- YAML
added: v0.11.14 added: v0.11.14
--> -->
@ -983,7 +983,7 @@ readable.resume();
readable.isPaused(); // === false readable.isPaused(); // === false
``` ```
##### readable.pause() ##### `readable.pause()`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -1010,7 +1010,7 @@ readable.on('data', (chunk) => {
The `readable.pause()` method has no effect if there is a `'readable'` The `readable.pause()` method has no effect if there is a `'readable'`
event listener. event listener.
##### readable.pipe(destination\[, options\]) ##### `readable.pipe(destination[, options])`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -1072,7 +1072,7 @@ to prevent memory leaks.
The [`process.stderr`][] and [`process.stdout`][] `Writable` streams are never The [`process.stderr`][] and [`process.stdout`][] `Writable` streams are never
closed until the Node.js process exits, regardless of the specified options. closed until the Node.js process exits, regardless of the specified options.
##### readable.read(\[size\]) ##### `readable.read([size])`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -1124,7 +1124,7 @@ also be emitted.
Calling [`stream.read([size])`][stream-read] after the [`'end'`][] event has Calling [`stream.read([size])`][stream-read] after the [`'end'`][] event has
been emitted will return `null`. No runtime error will be raised. been emitted will return `null`. No runtime error will be raised.
##### readable.readable ##### `readable.readable`
<!-- YAML <!-- YAML
added: v11.4.0 added: v11.4.0
--> -->
@ -1133,7 +1133,7 @@ added: v11.4.0
Is `true` if it is safe to call [`readable.read()`][stream-read]. Is `true` if it is safe to call [`readable.read()`][stream-read].
##### readable.readableEncoding ##### `readable.readableEncoding`
<!-- YAML <!-- YAML
added: v12.7.0 added: v12.7.0
--> -->
@ -1143,7 +1143,7 @@ added: v12.7.0
Getter for the property `encoding` of a given `Readable` stream. The `encoding` Getter for the property `encoding` of a given `Readable` stream. The `encoding`
property can be set using the [`readable.setEncoding()`][] method. property can be set using the [`readable.setEncoding()`][] method.
##### readable.readableEnded ##### `readable.readableEnded`
<!-- YAML <!-- YAML
added: v12.9.0 added: v12.9.0
--> -->
@ -1152,7 +1152,7 @@ added: v12.9.0
Becomes `true` when [`'end'`][] event is emitted. Becomes `true` when [`'end'`][] event is emitted.
##### readable.readableFlowing ##### `readable.readableFlowing`
<!-- YAML <!-- YAML
added: v9.4.0 added: v9.4.0
--> -->
@ -1162,7 +1162,7 @@ added: v9.4.0
This property reflects the current state of a `Readable` stream as described This property reflects the current state of a `Readable` stream as described
in the [Stream Three States][] section. in the [Stream Three States][] section.
##### readable.readableHighWaterMark ##### `readable.readableHighWaterMark`
<!-- YAML <!-- YAML
added: v9.3.0 added: v9.3.0
--> -->
@ -1172,7 +1172,7 @@ added: v9.3.0
Returns the value of `highWaterMark` passed when constructing this Returns the value of `highWaterMark` passed when constructing this
`Readable`. `Readable`.
##### readable.readableLength ##### `readable.readableLength`
<!-- YAML <!-- YAML
added: v9.4.0 added: v9.4.0
--> -->
@ -1183,7 +1183,7 @@ This property contains the number of bytes (or objects) in the queue
ready to be read. The value provides introspection data regarding ready to be read. The value provides introspection data regarding
the status of the `highWaterMark`. the status of the `highWaterMark`.
##### readable.readableObjectMode ##### `readable.readableObjectMode`
<!-- YAML <!-- YAML
added: v12.3.0 added: v12.3.0
--> -->
@ -1192,7 +1192,7 @@ added: v12.3.0
Getter for the property `objectMode` of a given `Readable` stream. Getter for the property `objectMode` of a given `Readable` stream.
##### readable.resume() ##### `readable.resume()`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
changes: changes:
@ -1221,7 +1221,7 @@ getReadableStreamSomehow()
The `readable.resume()` method has no effect if there is a `'readable'` The `readable.resume()` method has no effect if there is a `'readable'`
event listener. event listener.
##### readable.setEncoding(encoding) ##### `readable.setEncoding(encoding)`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -1253,7 +1253,7 @@ readable.on('data', (chunk) => {
}); });
``` ```
##### readable.unpipe(\[destination\]) ##### `readable.unpipe([destination])`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -1284,7 +1284,7 @@ setTimeout(() => {
}, 1000); }, 1000);
``` ```
##### readable.unshift(chunk\[, encoding\]) ##### `readable.unshift(chunk[, encoding])`
<!-- YAML <!-- YAML
added: v0.9.11 added: v0.9.11
changes: changes:
@ -1362,7 +1362,7 @@ custom stream). Following the call to `readable.unshift()` with an immediate
however it is best to simply avoid calling `readable.unshift()` while in the however it is best to simply avoid calling `readable.unshift()` while in the
process of performing a read. process of performing a read.
##### readable.wrap(stream) ##### `readable.wrap(stream)`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -1393,7 +1393,7 @@ myReader.on('readable', () => {
}); });
``` ```
##### readable\[Symbol.asyncIterator\]() ##### `readable[Symbol.asyncIterator]()`
<!-- YAML <!-- YAML
added: v10.0.0 added: v10.0.0
changes: changes:
@ -1428,7 +1428,7 @@ has less then 64kb of data because no `highWaterMark` option is provided to
### Duplex and Transform Streams ### Duplex and Transform Streams
#### Class: stream.Duplex #### Class: `stream.Duplex`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
changes: changes:
@ -1449,7 +1449,7 @@ Examples of `Duplex` streams include:
* [zlib streams][zlib] * [zlib streams][zlib]
* [crypto streams][crypto] * [crypto streams][crypto]
#### Class: stream.Transform #### Class: `stream.Transform`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -1465,7 +1465,7 @@ Examples of `Transform` streams include:
* [zlib streams][zlib] * [zlib streams][zlib]
* [crypto streams][crypto] * [crypto streams][crypto]
##### transform.destroy(\[error\]) ##### `transform.destroy([error])`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -1479,7 +1479,7 @@ Implementors should not override this method, but instead implement
The default implementation of `_destroy()` for `Transform` also emit `'close'` The default implementation of `_destroy()` for `Transform` also emit `'close'`
unless `emitClose` is set in false. unless `emitClose` is set in false.
### stream.finished(stream\[, options\], callback) ### `stream.finished(stream[, options], callback)`
<!-- YAML <!-- YAML
added: v10.0.0 added: v10.0.0
--> -->
@ -1552,7 +1552,7 @@ const cleanup = finished(rs, (err) => {
}); });
``` ```
### stream.pipeline(...streams, callback) ### `stream.pipeline(...streams, callback)`
<!-- YAML <!-- YAML
added: v10.0.0 added: v10.0.0
--> -->
@ -1613,7 +1613,7 @@ run().catch(console.error);
after the `callback` has been invoked. In the case of reuse of streams after after the `callback` has been invoked. In the case of reuse of streams after
failure, this can cause event listener leaks and swallowed errors. failure, this can cause event listener leaks and swallowed errors.
### stream.Readable.from(iterable, \[options\]) ### `stream.Readable.from(iterable, [options])`
<!-- YAML <!-- YAML
added: v12.3.0 added: v12.3.0
--> -->
@ -1731,7 +1731,7 @@ Custom `Writable` streams *must* call the `new stream.Writable([options])`
constructor and implement the `writable._write()` and/or `writable._writev()` constructor and implement the `writable._write()` and/or `writable._writev()`
method. method.
#### Constructor: new stream.Writable(\[options\]) #### Constructor: `new stream.Writable([options])`
<!-- YAML <!-- YAML
changes: changes:
- version: v10.0.0 - version: v10.0.0
@ -1817,7 +1817,7 @@ const myWritable = new Writable({
}); });
``` ```
#### writable.\_write(chunk, encoding, callback) #### `writable._write(chunk, encoding, callback)`
<!-- YAML <!-- YAML
changes: changes:
- version: v12.11.0 - version: v12.11.0
@ -1870,7 +1870,7 @@ The `writable._write()` method is prefixed with an underscore because it is
internal to the class that defines it, and should never be called directly by internal to the class that defines it, and should never be called directly by
user programs. user programs.
#### writable.\_writev(chunks, callback) #### `writable._writev(chunks, callback)`
* `chunks` {Object[]} The chunks to be written. Each chunk has following * `chunks` {Object[]} The chunks to be written. Each chunk has following
format: `{ chunk: ..., encoding: ... }`. format: `{ chunk: ..., encoding: ... }`.
@ -1890,7 +1890,7 @@ The `writable._writev()` method is prefixed with an underscore because it is
internal to the class that defines it, and should never be called directly by internal to the class that defines it, and should never be called directly by
user programs. user programs.
#### writable.\_destroy(err, callback) #### `writable._destroy(err, callback)`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -1902,7 +1902,7 @@ added: v8.0.0
The `_destroy()` method is called by [`writable.destroy()`][writable-destroy]. The `_destroy()` method is called by [`writable.destroy()`][writable-destroy].
It can be overridden by child classes but it **must not** be called directly. It can be overridden by child classes but it **must not** be called directly.
#### writable.\_final(callback) #### `writable._final(callback)`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -2011,7 +2011,7 @@ The `stream.Readable` class is extended to implement a [`Readable`][] stream.
Custom `Readable` streams *must* call the `new stream.Readable([options])` Custom `Readable` streams *must* call the `new stream.Readable([options])`
constructor and implement the `readable._read()` method. constructor and implement the `readable._read()` method.
#### new stream.Readable(\[options\]) #### `new stream.Readable([options])`
<!-- YAML <!-- YAML
changes: changes:
- version: v11.2.0 - version: v11.2.0
@ -2077,7 +2077,7 @@ const myReadable = new Readable({
}); });
``` ```
#### readable.\_read(size) #### `readable._read(size)`
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
--> -->
@ -2113,7 +2113,7 @@ The `readable._read()` method is prefixed with an underscore because it is
internal to the class that defines it, and should never be called directly by internal to the class that defines it, and should never be called directly by
user programs. user programs.
#### readable.\_destroy(err, callback) #### `readable._destroy(err, callback)`
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
--> -->
@ -2125,7 +2125,7 @@ added: v8.0.0
The `_destroy()` method is called by [`readable.destroy()`][readable-destroy]. The `_destroy()` method is called by [`readable.destroy()`][readable-destroy].
It can be overridden by child classes but it **must not** be called directly. It can be overridden by child classes but it **must not** be called directly.
#### readable.push(chunk\[, encoding\]) #### `readable.push(chunk[, encoding])`
<!-- YAML <!-- YAML
changes: changes:
- version: v8.0.0 - version: v8.0.0
@ -2268,7 +2268,7 @@ Custom `Duplex` streams *must* call the `new stream.Duplex([options])`
constructor and implement *both* the `readable._read()` and constructor and implement *both* the `readable._read()` and
`writable._write()` methods. `writable._write()` methods.
#### new stream.Duplex(options) #### `new stream.Duplex(options)`
<!-- YAML <!-- YAML
changes: changes:
- version: v8.4.0 - version: v8.4.0
@ -2437,7 +2437,7 @@ Care must be taken when using `Transform` streams in that data written to the
stream can cause the `Writable` side of the stream to become paused if the stream can cause the `Writable` side of the stream to become paused if the
output on the `Readable` side is not consumed. output on the `Readable` side is not consumed.
#### new stream.Transform(\[options\]) #### `new stream.Transform([options])`
* `options` {Object} Passed to both `Writable` and `Readable` * `options` {Object} Passed to both `Writable` and `Readable`
constructors. Also has the following fields: constructors. Also has the following fields:
@ -2484,7 +2484,7 @@ const myTransform = new Transform({
}); });
``` ```
#### Events: 'finish' and 'end' #### Events: `'finish'` and `'end'`
The [`'finish'`][] and [`'end'`][] events are from the `stream.Writable` The [`'finish'`][] and [`'end'`][] events are from the `stream.Writable`
and `stream.Readable` classes, respectively. The `'finish'` event is emitted and `stream.Readable` classes, respectively. The `'finish'` event is emitted
@ -2494,7 +2494,7 @@ after all data has been output, which occurs after the callback in
[`transform._flush()`][stream-_flush] has been called. In the case of an error, [`transform._flush()`][stream-_flush] has been called. In the case of an error,
neither `'finish'` nor `'end'` should be emitted. neither `'finish'` nor `'end'` should be emitted.
#### transform.\_flush(callback) #### `transform._flush(callback)`
* `callback` {Function} A callback function (optionally with an error * `callback` {Function} A callback function (optionally with an error
argument and data) to be called when remaining data has been flushed. argument and data) to be called when remaining data has been flushed.
@ -2522,7 +2522,7 @@ The `transform._flush()` method is prefixed with an underscore because it is
internal to the class that defines it, and should never be called directly by internal to the class that defines it, and should never be called directly by
user programs. user programs.
#### transform.\_transform(chunk, encoding, callback) #### `transform._transform(chunk, encoding, callback)`
* `chunk` {Buffer|string|any} The `Buffer` to be transformed, converted from * `chunk` {Buffer|string|any} The `Buffer` to be transformed, converted from
the `string` passed to [`stream.write()`][stream-write]. If the stream's the `string` passed to [`stream.write()`][stream-write]. If the stream's
@ -2576,7 +2576,7 @@ user programs.
queue mechanism, and to receive the next chunk, `callback` must be queue mechanism, and to receive the next chunk, `callback` must be
called, either synchronously or asynchronously. called, either synchronously or asynchronously.
#### Class: stream.PassThrough #### Class: `stream.PassThrough`
The `stream.PassThrough` class is a trivial implementation of a [`Transform`][] The `stream.PassThrough` class is a trivial implementation of a [`Transform`][]
stream that simply passes the input bytes across to the output. Its purpose is stream that simply passes the input bytes across to the output. Its purpose is