-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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.
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
doc: how to decode buffers extending from Writable #16403
Closed
Closed
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1510,6 +1510,39 @@ class MyWritable extends Writable { | |
} | ||
``` | ||
|
||
#### Decoding buffers in a Writable Stream | ||
|
||
Decoding buffers is a common task, for instance, when using transformers whose | ||
input is a string. This is not a trivial process when using multi-byte | ||
characters encoding. Implement it within [Writable][] implies some performance | ||
regressions. The following is an example of how to achieve that extending | ||
[Writable][]. | ||
|
||
```js | ||
const { Writable } = require('stream'); | ||
const { StringDecoder } = require('string_decoder'); | ||
|
||
class StringWritable extends Writable { | ||
constructor(options) { | ||
super(options); | ||
const state = this._writableState; | ||
this._decoder = new StringDecoder(state.defaultEncoding); | ||
this._data = ''; | ||
} | ||
_write(chunk, encoding, callback) { | ||
if (encoding === 'buffer') { | ||
chunk = this._decoder.write(chunk); | ||
} | ||
this._data += chunk; | ||
callback(); | ||
} | ||
_final(callback) { | ||
this._data += this._decoder.end(); | ||
callback(); | ||
} | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it would be good to add a quick example on how to use this. |
||
``` | ||
|
||
### Implementing a Readable Stream | ||
|
||
The `stream.Readable` class is extended to implement a [Readable][] stream. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add: "...multi-byte characters encoding, such as UTF-8."
I would remove the sentence "Implement it within Writable implies some performance regressions".
Then:
"The following example shows how to decode multi-byte strings using
StringDecoder
andWritable
."