summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2019-03-31 14:32:08 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2019-04-03 00:51:10 +0300
commit0e803d1d81375e0fa9318281d67b08f84cddf04a (patch)
tree5434906482210a441b3317213fc97f25815b1dc2 /doc
parente4c6c3bf2e6f8ee8f2d1d9b95fc731a5ac224fdf (diff)
downloadandroid-node-v8-0e803d1d81375e0fa9318281d67b08f84cddf04a.tar.gz
android-node-v8-0e803d1d81375e0fa9318281d67b08f84cddf04a.tar.bz2
android-node-v8-0e803d1d81375e0fa9318281d67b08f84cddf04a.zip
doc: add note about Buffer octets integer coercion
PR-URL: https://github.com/nodejs/node/pull/27030 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/buffer.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index afeef8b3c2..c626ba5e0d 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -12,7 +12,8 @@ streams in TCP streams, file system operations, and other contexts.
With [`TypedArray`] now available, the `Buffer` class implements the
[`Uint8Array`] API in a manner that is more optimized and suitable for Node.js.
-Instances of the `Buffer` class are similar to arrays of integers but
+Instances of the `Buffer` class are similar to arrays of integers from `0` to
+`255` (other integers are coerced to this range by `& 255` operation) but
correspond to fixed-sized, raw memory allocations outside the V8 heap.
The size of the `Buffer` is established when it is created and cannot be
changed.