Skip to content

Commit

Permalink
doc: improve 'hex' Buffer decoding description and examples
Browse files Browse the repository at this point in the history
PR-URL: #41598
Fixes: #41594
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Mestery <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
  • Loading branch information
gioragutt authored and danielleadams committed Mar 14, 2022
1 parent 0f3287d commit 5f0a017
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ string into a `Buffer` as decoding.
encoding a `Buffer` to a string, this encoding will omit padding.

* `'hex'`: Encode each byte as two hexadecimal characters. Data truncation
may occur when decoding strings that do exclusively contain valid hexadecimal
characters. See below for an example.
may occur when decoding strings that do not exclusively consist of an even
number of hexadecimal characters. See below for an example.

The following legacy character encodings are also supported:

Expand All @@ -199,11 +199,11 @@ The following legacy character encodings are also supported:
```mjs
import { Buffer } from 'buffer';

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

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

Buffer.from('1634', 'hex');
Expand All @@ -213,11 +213,11 @@ Buffer.from('1634', 'hex');
```cjs
const { Buffer } = require('buffer');

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

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

Buffer.from('1634', 'hex');
Expand Down

0 comments on commit 5f0a017

Please sign in to comment.