Skip to content

doc: make MDN links to global classes more consistent in buffer.md #56921

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
merged 1 commit into from
Feb 7, 2025
Merged

doc: make MDN links to global classes more consistent in buffer.md #56921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
77 changes: 35 additions & 42 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
`Buffer` objects are used to represent a fixed-length sequence of bytes. Many
Node.js APIs support `Buffer`s.

The `Buffer` class is a subclass of JavaScript's [`Uint8Array`][] class and
The `Buffer` class is a subclass of JavaScript's {Uint8Array} class and
extends it with methods that cover additional use cases. Node.js APIs accept
plain [`Uint8Array`][]s wherever `Buffer`s are supported as well.
plain {Uint8Array}s wherever `Buffer`s are supported as well.

While the `Buffer` class is available within the global scope, it is still
recommended to explicitly reference it via an import or require statement.
Expand Down Expand Up @@ -242,10 +242,10 @@ changes:
description: The `Buffer`s class now inherits from `Uint8Array`.
-->

`Buffer` instances are also JavaScript [`Uint8Array`][] and [`TypedArray`][]
instances. All [`TypedArray`][] methods are available on `Buffer`s. There are,
`Buffer` instances are also JavaScript {Uint8Array} and {TypedArray}
instances. All {TypedArray} methods are available on `Buffer`s. There are,
however, subtle incompatibilities between the `Buffer` API and the
[`TypedArray`][] API.
{TypedArray} API.

In particular:

Expand All @@ -258,9 +258,9 @@ In particular:
* [`buf.toString()`][] is incompatible with its `TypedArray` equivalent.
* A number of methods, e.g. [`buf.indexOf()`][], support additional arguments.

There are two ways to create new [`TypedArray`][] instances from a `Buffer`:
There are two ways to create new {TypedArray} instances from a `Buffer`:

* Passing a `Buffer` to a [`TypedArray`][] constructor will copy the `Buffer`s
* Passing a `Buffer` to a {TypedArray} constructor will copy the `Buffer`s
contents, interpreted as an array of integers, and not as a byte sequence
of the target type.

Expand All @@ -286,8 +286,8 @@ console.log(uint32array);
// Prints: Uint32Array(4) [ 1, 2, 3, 4 ]
```

* Passing the `Buffer`s underlying [`ArrayBuffer`][] will create a
[`TypedArray`][] that shares its memory with the `Buffer`.
* Passing the `Buffer`s underlying {ArrayBuffer} will create a
{TypedArray} that shares its memory with the `Buffer`.

```mjs
import { Buffer } from 'node:buffer';
Expand Down Expand Up @@ -318,7 +318,7 @@ console.log(uint16array);
```

It is possible to create a new `Buffer` that shares the same allocated
memory as a [`TypedArray`][] instance by using the `TypedArray` object's
memory as a {TypedArray} instance by using the `TypedArray` object's
`.buffer` property in the same way. [`Buffer.from()`][`Buffer.from(arrayBuf)`]
behaves like `new Uint8Array()` in this context.

Expand Down Expand Up @@ -376,8 +376,8 @@ console.log(buf2);
// Prints: <Buffer 88 13 70 17>
```

When creating a `Buffer` using a [`TypedArray`][]'s `.buffer`, it is
possible to use only a portion of the underlying [`ArrayBuffer`][] by passing in
When creating a `Buffer` using a {TypedArray}'s `.buffer`, it is
possible to use only a portion of the underlying {ArrayBuffer} by passing in
`byteOffset` and `length` parameters.

```mjs
Expand All @@ -401,7 +401,7 @@ console.log(buf.length);
```

The `Buffer.from()` and [`TypedArray.from()`][] have different signatures and
implementations. Specifically, the [`TypedArray`][] variants accept a second
implementations. Specifically, the {TypedArray} variants accept a second
argument that is a mapping function that is invoked on every element of the
typed array:

Expand Down Expand Up @@ -968,9 +968,8 @@ console.log(`${str}: ${str.length} characters, ` +
// Prints: ½ + ¼ = ¾: 9 characters, 12 bytes
```

When `string` is a `Buffer`/[`DataView`][]/[`TypedArray`][]/[`ArrayBuffer`][]/
[`SharedArrayBuffer`][], the byte length as reported by `.byteLength`
is returned.
When `string` is a {Buffer|DataView|TypedArray|ArrayBuffer|SharedArrayBuffer},
the byte length as reported by `.byteLength` is returned.

### Static method: `Buffer.compare(buf1, buf2)`

Expand Down Expand Up @@ -1025,7 +1024,7 @@ changes:
description: The elements of `list` can now be `Uint8Array`s.
-->

* `list` {Buffer\[] | Uint8Array\[]} List of `Buffer` or [`Uint8Array`][]
* `list` {Buffer\[] | Uint8Array\[]} List of `Buffer` or {Uint8Array}
instances to concatenate.
* `totalLength` {integer} Total length of the `Buffer` instances in `list`
when concatenated.
Expand Down Expand Up @@ -1159,18 +1158,18 @@ appropriate for `Buffer.from()` variants.
added: v5.10.0
-->

* `arrayBuffer` {ArrayBuffer|SharedArrayBuffer} An [`ArrayBuffer`][],
[`SharedArrayBuffer`][], for example the `.buffer` property of a
[`TypedArray`][].
* `arrayBuffer` {ArrayBuffer|SharedArrayBuffer} An {ArrayBuffer},
{SharedArrayBuffer}, for example the `.buffer` property of a
{TypedArray}.
* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.
* `length` {integer} Number of bytes to expose.
**Default:** `arrayBuffer.byteLength - byteOffset`.
* Returns: {Buffer}

This creates a view of the [`ArrayBuffer`][] without copying the underlying
This creates a view of the {ArrayBuffer} without copying the underlying
memory. For example, when passed a reference to the `.buffer` property of a
[`TypedArray`][] instance, the newly created `Buffer` will share the same
allocated memory as the [`TypedArray`][]'s underlying `ArrayBuffer`.
{TypedArray} instance, the newly created `Buffer` will share the same
allocated memory as the {TypedArray}'s underlying `ArrayBuffer`.

```mjs
import { Buffer } from 'node:buffer';
Expand Down Expand Up @@ -1237,8 +1236,8 @@ console.log(buf.length);
// Prints: 2
```

A `TypeError` will be thrown if `arrayBuffer` is not an [`ArrayBuffer`][] or a
[`SharedArrayBuffer`][] or another type appropriate for `Buffer.from()`
A `TypeError` will be thrown if `arrayBuffer` is not an {ArrayBuffer} or a
{SharedArrayBuffer} or another type appropriate for `Buffer.from()`
variants.

It is important to remember that a backing `ArrayBuffer` can cover a range
Expand Down Expand Up @@ -1276,7 +1275,7 @@ console.log(buf);
added: v5.10.0
-->

* `buffer` {Buffer|Uint8Array} An existing `Buffer` or [`Uint8Array`][] from
* `buffer` {Buffer|Uint8Array} An existing `Buffer` or {Uint8Array} from
which to copy data.
* Returns: {Buffer}

Expand Down Expand Up @@ -1636,7 +1635,7 @@ changes:
description: Additional parameters for specifying offsets are supported now.
-->

* `target` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`][] with which to
* `target` {Buffer|Uint8Array} A `Buffer` or {Uint8Array} with which to
compare `buf`.
* `targetStart` {integer} The offset within `target` at which to begin
comparison. **Default:** `0`.
Expand Down Expand Up @@ -1741,7 +1740,7 @@ console.log(buf1.compare(buf2, 5, 6, 5));
added: v0.1.90
-->

* `target` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`][] to copy into.
* `target` {Buffer|Uint8Array} A `Buffer` or {Uint8Array} to copy into.
* `targetStart` {integer} The offset within `target` at which to begin
writing. **Default:** `0`.
* `sourceStart` {integer} The offset within `buf` from which to begin copying.
Expand Down Expand Up @@ -1896,7 +1895,7 @@ changes:
description: The arguments can now be `Uint8Array`s.
-->

* `otherBuffer` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`][] with which to
* `otherBuffer` {Buffer|Uint8Array} A `Buffer` or {Uint8Array} with which to
compare `buf`.
* Returns: {boolean}

Expand Down Expand Up @@ -2141,7 +2140,7 @@ If `value` is:

* a string, `value` is interpreted according to the character encoding in
`encoding`.
* a `Buffer` or [`Uint8Array`][], `value` will be used in its entirety.
* a `Buffer` or {Uint8Array}, `value` will be used in its entirety.
To compare a partial `Buffer`, use [`buf.subarray`][].
* a number, `value` will be interpreted as an unsigned 8-bit integer
value between `0` and `255`.
Expand Down Expand Up @@ -5010,8 +5009,8 @@ changes:
> [`Buffer.from(arrayBuffer[, byteOffset[, length]])`][`Buffer.from(arrayBuf)`]
> instead.

* `arrayBuffer` {ArrayBuffer|SharedArrayBuffer} An [`ArrayBuffer`][],
[`SharedArrayBuffer`][] or the `.buffer` property of a [`TypedArray`][].
* `arrayBuffer` {ArrayBuffer|SharedArrayBuffer} An {ArrayBuffer},
{SharedArrayBuffer} or the `.buffer` property of a {TypedArray}.
* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.
* `length` {integer} Number of bytes to expose.
**Default:** `arrayBuffer.byteLength - byteOffset`.
Expand All @@ -5038,7 +5037,7 @@ changes:

> Stability: 0 - Deprecated: Use [`Buffer.from(buffer)`][] instead.

* `buffer` {Buffer|Uint8Array} An existing `Buffer` or [`Uint8Array`][] from
* `buffer` {Buffer|Uint8Array} An existing `Buffer` or {Uint8Array} from
which to copy data.

See [`Buffer.from(buffer)`][].
Expand Down Expand Up @@ -5114,7 +5113,7 @@ changes:

* Extends: {Blob}

A [`File`][] provides information about files.
A {File} provides information about files.

### `new buffer.File(sources, fileName[, options])`

Expand Down Expand Up @@ -5431,7 +5430,7 @@ differently based on what arguments are provided:
Buffer(num)` return a `Buffer` with initialized memory.
* Passing a string, array, or `Buffer` as the first argument copies the
passed object's data into the `Buffer`.
* Passing an [`ArrayBuffer`][] or a [`SharedArrayBuffer`][] returns a `Buffer`
* Passing an {ArrayBuffer} or a {SharedArrayBuffer} returns a `Buffer`
that shares allocated memory with the given array buffer.

Because the behavior of `new Buffer()` is different depending on the type of the
Expand Down Expand Up @@ -5465,7 +5464,7 @@ to one of these new APIs._
provided octets.
* [`Buffer.from(arrayBuffer[, byteOffset[, length]])`][`Buffer.from(arrayBuf)`]
returns a new `Buffer` that _shares the same allocated memory_ as the given
[`ArrayBuffer`][].
{ArrayBuffer}.
* [`Buffer.from(buffer)`][] returns a new `Buffer` that _contains a copy_ of the
contents of the given `Buffer`.
* [`Buffer.from(string[, encoding])`][`Buffer.from(string)`] returns a new
Expand Down Expand Up @@ -5527,7 +5526,6 @@ introducing security vulnerabilities into an application.
[UTF-16]: https://en.wikipedia.org/wiki/UTF-16
[UTF-8]: https://en.wikipedia.org/wiki/UTF-8
[WHATWG Encoding Standard]: https://encoding.spec.whatwg.org/
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
[`Blob`]: https://developer.mozilla.org/en-US/docs/Web/API/Blob
[`Buffer.alloc()`]: #static-method-bufferallocsize-fill-encoding
[`Buffer.allocUnsafe()`]: #static-method-bufferallocunsafesize
Expand All @@ -5539,21 +5537,16 @@ introducing security vulnerabilities into an application.
[`Buffer.from(buffer)`]: #static-method-bufferfrombuffer
[`Buffer.from(string)`]: #static-method-bufferfromstring-encoding
[`Buffer.poolSize`]: #class-property-bufferpoolsize
[`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView
[`ERR_INVALID_BUFFER_SIZE`]: errors.md#err_invalid_buffer_size
[`ERR_OUT_OF_RANGE`]: errors.md#err_out_of_range
[`File`]: https://developer.mozilla.org/en-US/docs/Web/API/File
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
[`String.prototype.indexOf()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf
[`String.prototype.lastIndexOf()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf
[`String.prototype.length`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length
[`TypedArray.from()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/from
[`TypedArray.prototype.set()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set
[`TypedArray.prototype.slice()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/slice
[`TypedArray.prototype.subarray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray
[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
[`buf.buffer`]: #bufbuffer
[`buf.compare()`]: #bufcomparetarget-targetstart-targetend-sourcestart-sourceend
[`buf.entries()`]: #bufentries
Expand Down
Loading