Skip to content

doc: clarify array args to Buffer.from() #48274

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

Merged
nodejs-github-bot merged 3 commits into from
Jun 2, 2023
Merged

doc: clarify array args to Buffer.from() #48274

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45707ae
doc: clarify array args to Buffer.from()
bengl May 31, 2023
48769ec
fixup! doc: clarify array args to Buffer.from()
bengl Jun 1, 2023
2a6c6e0
fixup! fixup! doc: clarify array args to Buffer.from()
bengl Jun 1, 2023
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
fixup! fixup! doc: clarify array args to Buffer.from()
  • Loading branch information
@bengl
bengl committed Jun 1, 2023
commit 2a6c6e02484116afb0a94d1dcc14cf82b908d4d3
9 changes: 5 additions & 4 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1119,10 +1119,10 @@ const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
```

If `array` is an `Array`-like object (that is, one with a `length` property of
type `number`), it is treated as if it is an array, unless it is a `Buffer` or a
`Uint8Array`. This means all other `TypedArray` variants get treated as an
`Array`. To create a `Buffer` from the underlying `ArrayBuffer`, use the
`.buffer` property directly.
type `number`), it is treated as if it is an array, unless it is a `Buffer` or
a `Uint8Array`. This means all other `TypedArray` variants get treated as an
`Array`. To create a `Buffer` from the bytes backing a `TypedArray`, use
[`Buffer.copyBytesFrom()`][].

A `TypeError` will be thrown if `array` is not an `Array` or another type
appropriate for `Buffer.from()` variants.
Expand Down Expand Up @@ -5496,6 +5496,7 @@ introducing security vulnerabilities into an application.
[`Buffer.allocUnsafe()`]: #static-method-bufferallocunsafesize
[`Buffer.allocUnsafeSlow()`]: #static-method-bufferallocunsafeslowsize
[`Buffer.concat()`]: #static-method-bufferconcatlist-totallength
[`Buffer.copyBytesFrom()`]: #static-method-buffercopybytesfromview-offset-length
[`Buffer.from(array)`]: #static-method-bufferfromarray
[`Buffer.from(arrayBuf)`]: #static-method-bufferfromarraybuffer-byteoffset-length
[`Buffer.from(buffer)`]: #static-method-bufferfrombuffer
Expand Down