Skip to content
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

doc: list encodings supported by buffer.transcode #22263

Closed
wants to merge 2 commits into from
Closed

doc: list encodings supported by buffer.transcode #22263

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e585f95
doc: list encodings supported by buffer.transcode
jasnell Aug 11, 2018
9577a29
squash! word change
Trott Aug 11, 2018
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
3 changes: 3 additions & 0 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2508,6 +2508,9 @@ encoding to another. Returns a new `Buffer` instance.
Throws if the `fromEnc` or `toEnc` specify invalid character encodings or if
conversion from `fromEnc` to `toEnc` is not permitted.

Encodings supported by `buffer.transcode()` include: `'ascii'`, `'utf8'`,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

include -> are assuming the list is supposed to be a complete list of supported encodings.

Copy link
Member Author

@jasnell jasnell Aug 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to make whatever editorial changes you'd like

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wanted to confirm the list is supposed to be complete before doing it. I'll take that as a "yes, it's a complete list" and make the change now. 👍

`'utf16le'`, `'ucs2'`, `'latin1'`, and `'binary'`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does 'hex' needs to be added here? (documentation)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. 'hex' is not supported


The transcoding process will use substitution characters if a given byte
sequence cannot be adequately represented in the target encoding. For instance:

Expand Down