node/doc/api/string_decoder.md
Rich Trott eb089e7ccd doc: add added: info for string_decoder
PR-URL: https://github.com/nodejs/node/pull/6741
Ref: https://github.com/nodejs/node/issues/6578
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
2016-05-15 22:56:51 -07:00

812 B

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.

const StringDecoder = require('string_decoder').StringDecoder;
const decoder = new StringDecoder('utf8');

const cent = Buffer.from([0xC2, 0xA2]);
console.log(decoder.write(cent));

const euro = Buffer.from([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.