doc: add string_decoder doc

pull/24503/head
Kyle Robinson Young 2012-04-19 23:32:58 -07:00 committed by Ben Noordhuis
parent c21c51a6fc
commit d91ef153e7
1 changed files with 24 additions and 0 deletions

View File

@ -0,0 +1,24 @@
# StringDecoder
Stability: 2 - Unstable
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.
var StringDecoder = require('string_decoder').StringDecoder;
var decoder = new StringDecoder('utf8');
var cent = new Buffer([0xC2, 0xA2]);
console.log(decoder.write(cent));
var euro = new Buffer([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));
## Class: StringDecoder
Accepts a single argument, `encoding` which defaults to `utf8`.
### StringDecoder.write(buffer)
Returns a decoded string.