From 3c8cf92c01fade5d90cfb06f14ac24ab47831413 Mon Sep 17 00:00:00 2001 From: Giora Guttsait Date: Sat, 22 Jan 2022 01:55:24 +0200 Subject: [PATCH] doc: improve `'hex'` Buffer decoding description and examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/41598 Fixes: https://github.com/nodejs/node/issues/41594 Reviewed-By: Benjamin Gruenbaum Reviewed-By: Antoine du Hamel Reviewed-By: Tobias Nießen Reviewed-By: Anna Henningsen Reviewed-By: Mestery Reviewed-By: Luigi Pinca Reviewed-By: Rich Trott --- doc/api/buffer.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 68183aed6a4011..67863b4e099d18 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -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: @@ -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 , data truncated when first non-hexadecimal value // ('g') encountered. -Buffer.from('1a7g', 'hex'); +Buffer.from('1a7', 'hex'); // Prints , data truncated when data ends in single digit ('7'). Buffer.from('1634', 'hex'); @@ -213,11 +213,11 @@ Buffer.from('1634', 'hex'); ```cjs const { Buffer } = require('buffer'); -Buffer.from('1ag', 'hex'); +Buffer.from('1ag123', 'hex'); // Prints , data truncated when first non-hexadecimal value // ('g') encountered. -Buffer.from('1a7g', 'hex'); +Buffer.from('1a7', 'hex'); // Prints , data truncated when data ends in single digit ('7'). Buffer.from('1634', 'hex');