node/doc/api/string_decoder.markdown

31 lines
724 B
Markdown
Raw Normal View History

2012-04-20 14:32:58 +08:00
# StringDecoder
Stability: 2 - Stable
2012-04-20 14:32:58 +08:00
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');
2012-04-20 14:32:58 +08:00
const cent = new Buffer([0xC2, 0xA2]);
console.log(decoder.write(cent));
2012-04-20 14:32:58 +08:00
const euro = new Buffer([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));
```
2012-04-20 14:32:58 +08:00
## Class: StringDecoder
Accepts a single argument, `encoding` which defaults to `'utf8'`.
2012-04-20 14:32:58 +08:00
### decoder.end()
Returns any trailing bytes that were left in the buffer.
### decoder.write(buffer)
Returns a decoded string.