Skip to content

doc: modify param description for end(),write() in StringDecoder #49285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 24, 2023
Merged

doc: modify param description for end(),write() in StringDecoder #49285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions doc/api/string_decoder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@ Creates a new `StringDecoder` instance.
added: v0.9.3
-->

* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or
`DataView` containing the bytes to decode.
* `buffer` {string|Buffer|TypedArray|DataView} The bytes to decode.
* Returns: {string}

Returns any remaining input stored in the internal buffer as a string. Bytes
Expand All @@ -86,8 +85,7 @@ changes:
character instead of one for each individual byte.
-->

* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or
`DataView` containing the bytes to decode.
* `buffer` {string|Buffer|TypedArray|DataView} The bytes to decode.
* Returns: {string}

Returns a decoded string, ensuring that any incomplete multibyte characters at
Expand Down