From e2325bcc0415a86a77faf06a8e85503db9f6618f Mon Sep 17 00:00:00 2001 From: Benjamin Chen Date: Tue, 28 Aug 2018 01:51:00 -0400 Subject: string_decoder: support typed array or data view Refs: https://github.com/nodejs/node/issues/1826 PR-URL: https://github.com/nodejs/node/pull/22562 Reviewed-By: Ruben Bridgewater Reviewed-By: Anna Henningsen Reviewed-By: Trivikram Kamat --- doc/api/string_decoder.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'doc/api/string_decoder.md') diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md index 1311f37255..c2e5434ac7 100644 --- a/doc/api/string_decoder.md +++ b/doc/api/string_decoder.md @@ -59,7 +59,8 @@ Creates a new `StringDecoder` instance. added: v0.9.3 --> -* `buffer` {Buffer} A `Buffer` containing the bytes to decode. +* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or + `DataView` containing the bytes to decode. * Returns: {string} Returns any remaining input stored in the internal buffer as a string. Bytes @@ -79,10 +80,11 @@ changes: character instead of one for each individual byte. --> -* `buffer` {Buffer} A `Buffer` containing the bytes to decode. +* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or + `DataView` 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 -internal buffer for the next call to `stringDecoder.write()` or -`stringDecoder.end()`. + the end of the `Buffer`, or `TypedArray`, or `DataView` are omitted from the + returned string and stored in an internal buffer for the next call to + `stringDecoder.write()` or `stringDecoder.end()`. -- cgit v1.2.3