30d9202f54Unify capitalization and spaces and add some info for consistency, clarity and coherence with sorting in the all.md / _toc.md. PR-URL: https://github.com/nodejs/node/pull/11230 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
39 lines
809 B
Markdown
39 lines
809 B
Markdown
# String Decoder
|
|
|
|
> 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
|
|
<!-- YAML
|
|
added: v0.1.99
|
|
-->
|
|
|
|
Accepts a single argument, `encoding` which defaults to `'utf8'`.
|
|
|
|
### decoder.end()
|
|
<!-- YAML
|
|
added: v0.9.3
|
|
-->
|
|
|
|
Returns any trailing bytes that were left in the buffer.
|
|
|
|
### decoder.write(buffer)
|
|
<!-- YAML
|
|
added: v0.1.99
|
|
-->
|
|
|
|
Returns a decoded string.
|