Skip to content

doc: make buffer.md more accurate #27030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vsemozhetbyt wants to merge 10 commits into from
Closed

doc: make buffer.md more accurate #27030

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e3d5d4d
doc: remove duplication in description
vsemozhetbyt Mar 30, 2019
ac2caec
doc: fix possible typo
vsemozhetbyt Mar 31, 2019
78f629a
doc: add missing types
vsemozhetbyt Mar 31, 2019
87d70b0
doc: unify number/integer types
vsemozhetbyt Mar 31, 2019
83052d2
doc: fix error notes in `Buffer.from()` variants
vsemozhetbyt Mar 30, 2019
142009e
doc: add note about Buffer octets integer coercion
vsemozhetbyt Mar 31, 2019
8b49feb
doc: mark optional parameters
vsemozhetbyt Mar 31, 2019
213fed4
doc: add notes about negative offsets
vsemozhetbyt Mar 31, 2019
fbf4c70
doc: unify periods in comments
vsemozhetbyt Mar 30, 2019
56da51a
doc: unify link formatting
vsemozhetbyt Mar 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: add note about Buffer octets integer coercion
  • Loading branch information
@vsemozhetbyt
vsemozhetbyt committed Apr 2, 2019
commit 142009e61de3f712a3af219b0814ded3e1278d8e
3 changes: 2 additions & 1 deletion doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down