summaryrefslogtreecommitdiff
path: root/doc/api/string_decoder.md
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-11 21:07:14 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-12 03:18:01 +0300
commitdf5d41bf93a304af4159398d0d9f44f0cba4ac94 (patch)
tree83970afaa89bf7328b7491a680a62e2acf988a40 /doc/api/string_decoder.md
parent068c001dee01e8ac7401e97249c5f61215aed233 (diff)
downloadandroid-node-v8-df5d41bf93a304af4159398d0d9f44f0cba4ac94.tar.gz
android-node-v8-df5d41bf93a304af4159398d0d9f44f0cba4ac94.tar.bz2
android-node-v8-df5d41bf93a304af4159398d0d9f44f0cba4ac94.zip
doc: add and unify even more return values
PR-URL: https://github.com/nodejs/node/pull/19955 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/string_decoder.md')
-rw-r--r--doc/api/string_decoder.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md
index 224d208e9c..5a8a5721b2 100644
--- a/doc/api/string_decoder.md
+++ b/doc/api/string_decoder.md
@@ -58,6 +58,7 @@ added: v0.9.3
-->
* `buffer` {Buffer} A `Buffer` containing the bytes to decode.
+* Returns: {string}
Returns any remaining input stored in the internal buffer as a string. Bytes
representing incomplete UTF-8 and UTF-16 characters will be replaced with
@@ -77,6 +78,7 @@ changes:
-->
* `buffer` {Buffer} A `Buffer` containing the bytes to decode.
+* Returns: {string}
Returns a decoded string, ensuring that any incomplete multibyte characters at
the end of the `Buffer` are omitted from the returned string and stored in an