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: explain hex encoding in Buffer API #31352

Closed
wants to merge 4 commits into from
Closed

doc: explain hex encoding in Buffer API #31352

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70ff15d
doc: explain `hex` encoding in Buffer API
HarshithaKP Jan 14, 2020
77cf202
fixup: address review comments
HarshithaKP Jan 14, 2020
687693e
fixup: address review comment
HarshithaKP Jan 16, 2020
6b8c1c2
fixup: address review comments
HarshithaKP Jan 17, 2020
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
15 changes: 14 additions & 1 deletion doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,20 @@ The character encodings currently supported by Node.js include:

* `'binary'`: Alias for `'latin1'`.

* `'hex'`: Encode each byte as two hexadecimal characters.
* `'hex'`: Encode each byte as two hexadecimal characters. Data truncation
may occur for unsanitized input. For example:

```js
Buffer.from('1ag', 'hex');
// Prints <Buffer 1a>, data truncated when first non-hexadecimal value
// ('g') encountered
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// ('g') encountered
// ('g') encountered.

Copy link
Member Author

Choose a reason for hiding this comment

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

@Trott, ditto.


Buffer.from('1a7g', 'hex');
// Prints <Buffer 1a>, data truncated when data ends in single digit ('7').

Buffer.from('1634', 'hex');
// Prints <Buffer 16 34>, fully qualified hexadecimal data
Copy link
Member

@Trott Trott Jan 16, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Optional nit: Saying that the data was not truncated might be easier to understand than describing it as fully-qualified.

Suggested change
// Prints <Buffer 16 34>, fully qualified hexadecimal data
// Prints <Buffer 16 34>, all data represented.

Copy link
Member Author

Choose a reason for hiding this comment

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

@Trott, thanks. Fixed it.

```

Modern Web browsers follow the [WHATWG Encoding Standard][] which aliases
both `'latin1'` and `'ISO-8859-1'` to `'win-1252'`. This means that while doing
Expand Down