diff options
| author | Jan-Philip Gehrcke <jp@opstrace.com> | 2019-11-28 19:30:52 +0100 |
|---|---|---|
| committer | Anna Henningsen <anna@addaleax.net> | 2019-12-03 23:27:11 +0100 |
| commit | c0905b71adb55cbf98816dd993fec2d7c17ebbfe (patch) | |
| tree | dc9d7262dc751de87eedaacbc1ff039cc54a3d70 /doc | |
| parent | b52deecce583be22dcd66a0208d452261c1a175a (diff) | |
| download | android-node-v8-c0905b71adb55cbf98816dd993fec2d7c17ebbfe.tar.gz android-node-v8-c0905b71adb55cbf98816dd993fec2d7c17ebbfe.tar.bz2 android-node-v8-c0905b71adb55cbf98816dd993fec2d7c17ebbfe.zip | |
doc: Buffer.toString(): add note about invalid data
PR-URL: https://github.com/nodejs/node/pull/30706
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/buffer.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md index a97ab6c2a6..c5b7bf1504 100644 --- 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`][]. |