summaryrefslogtreecommitdiff
path: root/doc/api/string_decoder.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/string_decoder.md')
-rw-r--r--doc/api/string_decoder.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md
new file mode 100644
index 0000000000..d1de27dc4a
--- /dev/null
+++ b/doc/api/string_decoder.md
@@ -0,0 +1,30 @@
+# 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.