doc: clarify the behavior of Buffer.byteLength

PR-URL: nodejs#11238 Refs: nodejs#11165 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
krydos · Feb 25, 2017 · 43dbfc9 · 43dbfc9
1 parent 73adab4
commit 43dbfc9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -618,6 +618,10 @@ Returns the actual byte length of a string. This is not the same as
 [`String.prototype.length`] since that returns the number of *characters* in
 a string.
 
+*Note* that for `'base64'` and `'hex'`, this function assumes valid input. For
+strings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return
+value might be greater than the length of a `Buffer` created from the string.
+
 Example:
 
 ```js