mirror of
https://github.com/nodejs/node.git
synced 2025-05-14 22:56:41 +00:00
e436272897
This changes the code blocks from 4-space indentation to ``` fences for better syntax highlighting and future linting support. Minor On-the-fly changes for typos and highlight breaking markdown have been made. JSON-Style objects have been changed so their closing bracket is on the same line as the opening one. Known issues: * Not every JSON / object notation has been improved. Should make another run for this. * Some example functions break hightlighting due to various combinations of brackets. However changing them means leaving the code style. Fixes: https://github.com/nodejs/node/issues/4726 PR-URL: https://github.com/nodejs/node/pull/4733 Reviewed-By: Roman Reiss <me@silverwind.io>
31 lines
724 B
Markdown
31 lines
724 B
Markdown
# StringDecoder
|
|
|
|
Stability: 2 - Stable
|
|
|
|
To use this module, do `require('string_decoder')`. StringDecoder decodes a
|
|
buffer to a string. It is a simple interface to `buffer.toString()` but provides
|
|
additional support for utf8.
|
|
|
|
```js
|
|
const StringDecoder = require('string_decoder').StringDecoder;
|
|
const decoder = new StringDecoder('utf8');
|
|
|
|
const cent = new Buffer([0xC2, 0xA2]);
|
|
console.log(decoder.write(cent));
|
|
|
|
const euro = new Buffer([0xE2, 0x82, 0xAC]);
|
|
console.log(decoder.write(euro));
|
|
```
|
|
|
|
## Class: StringDecoder
|
|
|
|
Accepts a single argument, `encoding` which defaults to `'utf8'`.
|
|
|
|
### decoder.end()
|
|
|
|
Returns any trailing bytes that were left in the buffer.
|
|
|
|
### decoder.write(buffer)
|
|
|
|
Returns a decoded string.
|