doc: Buffer.toString(): add note about invalid data

PR-URL: #30706 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: David Carlier <[email protected]>
nodejs · Dec 9, 2019 · 9428304 · 9428304
1 parent 8369562
commit 9428304
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -2162,6 +2162,8 @@ added: v0.1.90
 
 Decodes `buf` to a string according to the specified character encoding in
 `encoding`. `start` and `end` may be passed to decode only a subset of `buf`.
+If a byte sequence in the input is not valid in the given `encoding` then
+it is replaced with the replacement character `U+FFFD`.
 
 The maximum length of a string instance (in UTF-16 code units) is available
 as [`buffer.constants.MAX_STRING_LENGTH`][].