diff --git a/.eslintignore b/.eslintignore
index 38625b1002..9d06233755 100644
--- a/.eslintignore
+++ b/.eslintignore
@@ -2,3 +2,4 @@
public
docs/
meetings/
+build/
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
deleted file mode 100644
index 4604b5c98c..0000000000
--- a/.github/dependabot.yml
+++ /dev/null
@@ -1,13 +0,0 @@
-version: 2
-updates:
- - package-ecosystem: github-actions
- directory: '/'
- schedule:
- interval: daily
- open-pull-requests-limit: 99
-
- - package-ecosystem: npm
- directory: '/'
- schedule:
- interval: monthly
- open-pull-requests-limit: 99
diff --git a/README.md b/README.md
index 6ea8cec7b9..35f4177fa3 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
+### Repository Archival Notice ⚠️
+
+This repository is discontinued and archived. Please follow-up the recent announcement [here](https://github.com/nodejs/nodejs.org/discussions/5131) as development continues on the [`nodejs/nodejs.org`](https://github.com/nodejs/nodejs.org) repository.
+
+Thank you all for your contributions over the years!
+
+----------
+
diff --git a/apiUrls.js b/apiUrls.js
index 0e263788cb..fcd49fa3d6 100644
--- a/apiUrls.js
+++ b/apiUrls.js
@@ -6,7 +6,7 @@ module.exports = {
'https://raw.githubusercontent.com/nodejs/Release/main/schedule.json',
nodeReleaseData: 'https://nodejs.org/dist/index.json',
nodeBannersData:
- 'https://raw.githubusercontent.com/nodejs/nodejs.org/main/locale/en/site.json',
+ 'https://raw.githubusercontent.com/nodejs/nodejs.org/main/site.json',
jsonLink: (fileName, version) =>
`https://nodejs.org/docs/latest-${version}.x/api/${fileName}.json`,
};
diff --git a/content/about/about.en.md b/content/about/about.en.md
index 656e3ce025..691a6ac730 100644
--- a/content/about/about.en.md
+++ b/content/about/about.en.md
@@ -11,7 +11,7 @@ scalable network applications. In the following "hello world" example, many
connections can be handled concurrently. Upon each connection, the callback is
fired, but if there is no work to be done, Node.js will sleep.
-```javascript
+```js
const http = require('http');
const hostname = '127.0.0.1';
diff --git a/content/about/about.ja.md b/content/about/about.ja.md
index 48deb2b26d..8794d90980 100644
--- a/content/about/about.ja.md
+++ b/content/about/about.ja.md
@@ -8,7 +8,7 @@ category: about
Node.js は、非同期のイベントドリブン JavaScript ランタイムとして、スケーラブルなネットワークアプリケーションを構築するために設計されています。次の "hello world" の例では、多くの接続を同時に処理できます。接続を並列に処理することができます。各接続の際に、コールバックが呼び出されます。しかし、何もすることがない場合は、Node.js はスリープします。
-```javascript
+```js
const http = require('http');
const hostname = '127.0.0.1';
diff --git a/content/about/about.pt.md b/content/about/about.pt.md
index 0e739f85bc..1c887439e5 100644
--- a/content/about/about.pt.md
+++ b/content/about/about.pt.md
@@ -8,7 +8,7 @@ category: about
Como executor de JavaScript orientado a eventos assíncronos, a Node está desenhada para construir aplicações de rede escaláveis. No seguinte exemplo "hello world" ou "olá mundo" em Português, várias conexões podem ser manipuladas simultaneamente. Sobre cada conexão, uma função de resposta é disparada, mas se não existe nada a ser feito, a Node.js adormecerá.
-```javascript
+```js
const http = require('http');
const hostname = '127.0.0.1';
diff --git a/content/about/branding.en.md b/content/about/branding.en.md
new file mode 100644
index 0000000000..874fde9150
--- /dev/null
+++ b/content/about/branding.en.md
@@ -0,0 +1,163 @@
+---
+title: branding
+displayTitle: Branding of Node.js
+description: 'Branding | Node.js'
+authors: AugustinMauroy, XhmikosR, mikeal, fhemberger, Fishrock123, yous, tomgco, tniessen, SMcCandlish, saadq, Trott, Gornstats, piperchester, naoufal, lpinca, j9t, bnoordhuis, harshadsabne, Chris911, MrJithil
+category: about
+---
+
+Please review the [trademark policy](https://trademark-policy.openjsf.org/) for information about permissible use of Node.js® logos and marks.
+
+## Color
+
+The following colors are the color palette for the Node.js website. And should be used for other documents.
+
+### Brand colors
+
+
+
+### Neutral colors
+
+
+
+### Status colors
+
+**Danger**
+
+
+
+**Warning**
+
+
+
+**Info**
+
+
+
+### Accent colors
+
+**Accent 1**
+
+
+
+**Accent 2**
+
+
+
+## Font
+
+**Font Name**: Open Sans
+
+**Download**: [www.google.com/fonts/specimen/Open+Sans](https://www.google.com/fonts/specimen/Open+Sans)
+
+## Nodejs logos
+
+### Logos with JS hexagon at right
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+### Logos with JS hexagon at bottom
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Assets
+
+### Hexagon
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+### JS from Node.js logo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/content/about/resources.en.md b/content/about/resources.en.md
deleted file mode 100644
index e33c0dbaf1..0000000000
--- a/content/about/resources.en.md
+++ /dev/null
@@ -1,32 +0,0 @@
----
-title: resources
-displayTitle: Resources
-description: 'Resources | Node.js'
-authors: XhmikosR, mikeal, fhemberger, Fishrock123, yous, tomgco, tniessen, SMcCandlish, saadq, Trott, Gornstats, piperchester, naoufal, lpinca, j9t, bnoordhuis, harshadsabne, Chris911, MrJithil
-category: about
----
-
-## Logo Downloads
-
-Please review the [trademark policy](https://trademark-policy.openjsf.org/) for information about permissible use of Node.js® logos and marks.
-
-Guidelines for the visual display of the Node.js mark are described in the [Visual Guidelines](/static/documents/foundation-visual-guidelines.pdf).
-
-
diff --git a/content/about/resources.fr.md b/content/about/resources.fr.md
deleted file mode 100644
index 2eb8b13d52..0000000000
--- a/content/about/resources.fr.md
+++ /dev/null
@@ -1,32 +0,0 @@
----
-title: resources
-displayTitle: Ressources
-description: "Ressources | Node.js"
-authors: XhmikosR, mikeal, fhemberger, Fishrock123, yous, tomgco, tniessen, SMcCandlish, saadq, Trott, Gornstats, piperchester, naoufal, lpinca, j9t, bnoordhuis, harshadsabne, Chris911, MrJithil, AugustinMauroy
-category: about
----
-
-## Téléchargements de logos
-
-Veuillez consulter la [politique de marque](https://trademark-policy.openjsf.org/) pour obtenir des informations sur l'utilisation autorisée des logos et des marques de Node.js®.
-
-Les directives relatives à l'affichage de la marque Node.js sont décrites dans les [Directives visuelles] (/static/documents/foundation-visual-guidelines.pdf).
-
-
diff --git a/content/api/v16/assert.en.md b/content/api/v16/assert.en.md
index 955bc8b765..30296972d4 100644
--- a/content/api/v16/assert.en.md
+++ b/content/api/v16/assert.en.md
@@ -13,7 +13,7 @@ Stable
-
console.log(Buffer.from('fhqwhgads', 'utf16le'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('hello world', 'utf8');
@@ -194,7 +190,7 @@ The following legacy character encodings are also supported:
of UTF-16 that did not support characters that had code points larger than
U+FFFF. In Node.js, these code points are always supported.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
Buffer.from('1ag123', 'hex');
@@ -206,9 +202,7 @@ Buffer.from('1a7', 'hex');
Buffer.from('1634', 'hex');
// Prints , all data represented.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
Buffer.from('1ag123', 'hex');
@@ -255,7 +249,7 @@ There are two ways to create new [`TypedArray`][] instances from a `Buffer`:
contents, interpreted as an array of integers, and not as a byte sequence
of the target type.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
@@ -264,9 +258,7 @@ const uint32array = new Uint32Array(buf);
console.log(uint32array);
// Prints: Uint32Array(4) [ 1, 2, 3, 4 ]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -280,7 +272,7 @@ console.log(uint32array);
* Passing the `Buffer`s underlying [`ArrayBuffer`][] will create a
[`TypedArray`][] that shares its memory with the `Buffer`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('hello', 'utf16le');
@@ -292,9 +284,7 @@ const uint16array = new Uint16Array(
console.log(uint16array);
// Prints: Uint16Array(5) [ 104, 101, 108, 108, 111 ]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('hello', 'utf16le');
@@ -313,7 +303,7 @@ 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.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arr = new Uint16Array(2);
@@ -338,9 +328,7 @@ console.log(buf1);
// Prints:
console.log(buf2);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(2);
@@ -371,7 +359,7 @@ 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
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arr = new Uint16Array(20);
@@ -379,9 +367,7 @@ const buf = Buffer.from(arr.buffer, 0, 16);
console.log(buf.length);
// Prints: 16
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(20);
@@ -410,7 +396,7 @@ function:
`Buffer` instances can be iterated over using `for..of` syntax:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3]);
@@ -422,9 +408,7 @@ for (const b of buf) {
// 1
// 2
// 3
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3]);
@@ -530,7 +514,7 @@ destinations without transferring or immediately copying the data. The data
contained by the `Blob` is copied only when the `arrayBuffer()` or `text()`
methods are called.
-```mjs
+```mjs|cjs
import { Blob, Buffer } from 'node:buffer';
import { setTimeout as delay } from 'node:timers/promises';
@@ -555,9 +539,7 @@ mc2.port2.postMessage(blob);
// The Blob is still usable after posting.
blob.text().then(console.log);
-```
-
-```cjs
+--------------
const { Blob, Buffer } = require('node:buffer');
const { setTimeout: delay } = require('node:timers/promises');
@@ -602,16 +584,14 @@ It can be constructed in a variety of ways.
Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the
`Buffer` will be zero-filled.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(5);
@@ -627,16 +607,14 @@ is thrown.
If `fill` is specified, the allocated `Buffer` will be initialized by calling
[`buf.fill(fill)`][`buf.fill()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5, 'a');
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(5, 'a');
@@ -648,16 +626,14 @@ console.log(buf);
If both `fill` and `encoding` are specified, the allocated `Buffer` will be
initialized by calling [`buf.fill(fill, encoding)`][`buf.fill()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
@@ -688,7 +664,7 @@ initialized_. The contents of the newly created `Buffer` are unknown and
_may contain sensitive data_. Use [`Buffer.alloc()`][] instead to initialize
`Buffer` instances with zeroes.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(10);
@@ -700,9 +676,7 @@ buf.fill(0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(10);
@@ -760,7 +734,7 @@ memory from a pool for an indeterminate amount of time, it may be appropriate
to create an un-pooled `Buffer` instance using `Buffer.allocUnsafeSlow()` and
then copying out the relevant bits.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Need to keep around a few small chunks of memory.
@@ -778,9 +752,7 @@ socket.on('readable', () => {
store.push(sb);
}
});
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Need to keep around a few small chunks of memory.
@@ -821,7 +793,7 @@ For strings that contain non-base64/hex-encoded data (e.g. whitespace), the
return value might be greater than the length of a `Buffer` created from the
string.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const str = '\u00bd + \u00bc = \u00be';
@@ -829,9 +801,7 @@ const str = '\u00bd + \u00bc = \u00be';
console.log(`${str}: ${str.length} characters, ` +
`${Buffer.byteLength(str, 'utf8')} bytes`);
// Prints: ½ + ¼ = ¾: 9 characters, 12 bytes
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const str = '\u00bd + \u00bc = \u00be';
@@ -858,7 +828,7 @@ Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of
`Buffer` instances. This is equivalent to calling
[`buf1.compare(buf2)`][`buf.compare()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('1234');
@@ -868,9 +838,7 @@ const arr = [buf1, buf2];
console.log(arr.sort(Buffer.compare));
// Prints: [ , ]
// (This result is equal to: [buf2, buf1].)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('1234');
@@ -905,7 +873,7 @@ If `totalLength` is provided, it is coerced to an unsigned integer. If the
combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is
truncated to `totalLength`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a single `Buffer` from a list of three `Buffer` instances.
@@ -924,9 +892,7 @@ console.log(bufA);
// Prints:
console.log(bufA.length);
// Prints: 42
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a single `Buffer` from a list of three `Buffer` instances.
@@ -959,14 +925,12 @@ console.log(bufA.length);
Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`.
Array entries outside that range will be truncated to fit into it.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
@@ -995,7 +959,7 @@ 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`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arr = new Uint16Array(2);
@@ -1014,9 +978,7 @@ arr[1] = 6000;
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(2);
@@ -1040,7 +1002,7 @@ console.log(buf);
The optional `byteOffset` and `length` arguments specify a memory range within
the `arrayBuffer` that will be shared by the `Buffer`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const ab = new ArrayBuffer(10);
@@ -1048,9 +1010,7 @@ const buf = Buffer.from(ab, 0, 2);
console.log(buf.length);
// Prints: 2
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const ab = new ArrayBuffer(10);
@@ -1069,7 +1029,7 @@ of memory that extends beyond the bounds of a `TypedArray` view. A new
`Buffer` created using the `buffer` property of a `TypedArray` may extend
beyond the range of the `TypedArray`:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 elements
@@ -1079,9 +1039,7 @@ console.log(arrA.buffer === arrB.buffer); // true
const buf = Buffer.from(arrB.buffer);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 elements
@@ -1102,7 +1060,7 @@ console.log(buf);
Copies the passed `buffer` data onto a new `Buffer` instance.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('buffer');
@@ -1114,9 +1072,7 @@ console.log(buf1.toString());
// Prints: auffer
console.log(buf2.toString());
// Prints: buffer
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('buffer');
@@ -1144,14 +1100,12 @@ appropriate for `Buffer.from()` variants.
For objects whose `valueOf()` function returns a value not strictly equal to
`object`, returns `Buffer.from(object.valueOf(), offsetOrEncoding, length)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from(new String('this is a test'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from(new String('this is a test'));
@@ -1161,7 +1115,7 @@ const buf = Buffer.from(new String('this is a test'));
For objects that support `Symbol.toPrimitive`, returns
`Buffer.from(object[Symbol.toPrimitive]('string'), offsetOrEncoding)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
class Foo {
@@ -1172,9 +1126,7 @@ class Foo {
const buf = Buffer.from(new Foo(), 'utf8');
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
class Foo {
@@ -1200,7 +1152,7 @@ is not of another type appropriate for `Buffer.from()` variants.
Creates a new `Buffer` containing `string`. The `encoding` parameter identifies
the character encoding to be used when converting `string` into bytes.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('this is a tést');
@@ -1212,9 +1164,7 @@ console.log(buf2.toString());
// Prints: this is a tést
console.log(buf1.toString('latin1'));
// Prints: this is a tést
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('this is a tést');
@@ -1240,7 +1190,7 @@ appropriate for `Buffer.from()` variants.
Returns `true` if `obj` is a `Buffer`, `false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
Buffer.isBuffer(Buffer.alloc(10)); // true
@@ -1248,9 +1198,7 @@ Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
Buffer.isBuffer(Buffer.alloc(10)); // true
@@ -1270,7 +1218,7 @@ Buffer.isBuffer(new Uint8Array(1024)); // false
Returns `true` if `encoding` is the name of a supported character encoding,
or `false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
console.log(Buffer.isEncoding('utf8'));
@@ -1284,9 +1232,7 @@ console.log(Buffer.isEncoding('utf/8'));
console.log(Buffer.isEncoding(''));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
console.log(Buffer.isEncoding('utf8'));
@@ -1325,7 +1271,7 @@ access is the same as `Uint8Array`. In other words, `buf[index]` returns
`buf[index] = value` does not modify the buffer if `index` is negative or
`>= buf.length`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Copy an ASCII string into a `Buffer` one byte at a time.
@@ -1341,9 +1287,7 @@ for (let i = 0; i < str.length; i++) {
console.log(buf.toString('utf8'));
// Prints: Node.js
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Copy an ASCII string into a `Buffer` one byte at a time.
@@ -1369,7 +1313,7 @@ console.log(buf.toString('utf8'));
This `ArrayBuffer` is not guaranteed to correspond exactly to the original
`Buffer`. See the notes on `buf.byteOffset` for details.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arrayBuffer = new ArrayBuffer(16);
@@ -1377,9 +1321,7 @@ const buffer = Buffer.from(arrayBuffer);
console.log(buffer.buffer === arrayBuffer);
// Prints: true
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arrayBuffer = new ArrayBuffer(16);
@@ -1404,7 +1346,7 @@ to the `Buffer` object itself.
A common issue when creating a `TypedArray` object that shares its memory with
a `Buffer` is that in this case one needs to specify the `byteOffset` correctly:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a buffer smaller than `Buffer.poolSize`.
@@ -1414,9 +1356,7 @@ const nodeBuffer = Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
// to refer only to the part of `nodeBuffer.buffer` that contains the memory
// for `nodeBuffer`.
new Int8Array(nodeBuffer.buffer, nodeBuffer.byteOffset, nodeBuffer.length);
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a buffer smaller than `Buffer.poolSize`.
@@ -1452,7 +1392,7 @@ Comparison is based on the actual sequence of bytes in each `Buffer`.
* `1` is returned if `target` should come _before_ `buf` when sorted.
* `-1` is returned if `target` should come _after_ `buf` when sorted.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
@@ -1472,9 +1412,7 @@ console.log(buf2.compare(buf3));
console.log([buf1, buf2, buf3].sort(Buffer.compare));
// Prints: [ , , ]
// (This result is equal to: [buf1, buf3, buf2].)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('ABC');
@@ -1500,7 +1438,7 @@ The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`
arguments can be used to limit the comparison to specific ranges within `target`
and `buf` respectively.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
@@ -1512,9 +1450,7 @@ console.log(buf1.compare(buf2, 0, 6, 4));
// Prints: -1
console.log(buf1.compare(buf2, 5, 6, 5));
// Prints: 1
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
@@ -1551,7 +1487,7 @@ memory region overlaps with `buf`.
for all TypedArrays, including Node.js `Buffer`s, although it takes
different function arguments.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create two `Buffer` instances.
@@ -1570,9 +1506,7 @@ buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create two `Buffer` instances.
@@ -1593,7 +1527,7 @@ console.log(buf2.toString('ascii', 0, 25));
// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
```
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` and copy data from one region to an overlapping region
@@ -1610,9 +1544,7 @@ buf.copy(buf, 0, 4, 10);
console.log(buf.toString());
// Prints: efghijghijklmnopqrstuvwxyz
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` and copy data from one region to an overlapping region
@@ -1640,7 +1572,7 @@ console.log(buf.toString());
Creates and returns an [iterator][] of `[index, byte]` pairs from the contents
of `buf`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Log the entire contents of a `Buffer`.
@@ -1657,9 +1589,7 @@ for (const pair of buf.entries()) {
// [3, 102]
// [4, 101]
// [5, 114]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Log the entire contents of a `Buffer`.
@@ -1690,7 +1620,7 @@ Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,
`false` otherwise. Equivalent to
[`buf.compare(otherBuffer) === 0`][`buf.compare()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
@@ -1701,9 +1631,7 @@ console.log(buf1.equals(buf2));
// Prints: true
console.log(buf1.equals(buf3));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('ABC');
@@ -1732,7 +1660,7 @@ console.log(buf1.equals(buf3));
Fills `buf` with the specified `value`. If the `offset` and `end` are not given,
the entire `buf` will be filled:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with the ASCII character 'h'.
@@ -1741,9 +1669,7 @@ const b = Buffer.allocUnsafe(50).fill('h');
console.log(b.toString());
// Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Fill a `Buffer` with the ASCII character 'h'.
@@ -1761,16 +1687,14 @@ filled with `value & 255`.
If the final write of a `fill()` operation falls on a multi-byte character,
then only the bytes of that character that fit into `buf` are written:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with character that takes up two bytes in UTF-8.
console.log(Buffer.allocUnsafe(5).fill('\u0222'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Fill a `Buffer` with character that takes up two bytes in UTF-8.
@@ -1782,7 +1706,7 @@ console.log(Buffer.allocUnsafe(5).fill('\u0222'));
If `value` contains invalid characters, it is truncated; if no valid
fill data remains, an exception is thrown:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(5);
@@ -1793,9 +1717,7 @@ console.log(buf.fill('aazz', 'hex'));
// Prints:
console.log(buf.fill('zz', 'hex'));
// Throws an exception.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(5);
@@ -1821,7 +1743,7 @@ console.log(buf.fill('zz', 'hex'));
Equivalent to [`buf.indexOf() !== -1`][`buf.indexOf()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
@@ -1840,9 +1762,7 @@ console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: true
console.log(buf.includes('this', 4));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this is a buffer');
@@ -1885,7 +1805,7 @@ If `value` is:
* a number, `value` will be interpreted as an unsigned 8-bit integer
value between `0` and `255`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
@@ -1909,9 +1829,7 @@ console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
// Prints: 4
console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
// Prints: 6
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this is a buffer');
@@ -1945,7 +1863,7 @@ If `byteOffset` is not a number, it will be coerced to a number. If the result
of coercion is `NaN` or `0`, then the entire buffer will be searched. This
behavior matches [`String.prototype.indexOf()`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const b = Buffer.from('abcdef');
@@ -1961,9 +1879,7 @@ console.log(b.indexOf('b', undefined));
console.log(b.indexOf('b', {}));
console.log(b.indexOf('b', null));
console.log(b.indexOf('b', []));
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const b = Buffer.from('abcdef');
@@ -1993,7 +1909,7 @@ than `buf.length`, `byteOffset` will be returned. If `value` is empty and
Creates and returns an [iterator][] of `buf` keys (indices).
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -2008,9 +1924,7 @@ for (const key of buf.keys()) {
// 3
// 4
// 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -2044,7 +1958,7 @@ for (const key of buf.keys()) {
Identical to [`buf.indexOf()`][], except the last occurrence of `value` is found
rather than the first occurrence.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this buffer is a buffer');
@@ -2070,9 +1984,7 @@ console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// Prints: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// Prints: 4
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this buffer is a buffer');
@@ -2108,7 +2020,7 @@ If `byteOffset` is not a number, it will be coerced to a number. Any arguments
that coerce to `NaN`, like `{}` or `undefined`, will search the whole buffer.
This behavior matches [`String.prototype.lastIndexOf()`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const b = Buffer.from('abcdef');
@@ -2127,9 +2039,7 @@ console.log(b.lastIndexOf('b', {}));
// Prints: -1, equivalent to passing 0.
console.log(b.lastIndexOf('b', null));
console.log(b.lastIndexOf('b', []));
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const b = Buffer.from('abcdef');
@@ -2160,7 +2070,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
Returns the number of bytes in `buf`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` and write a shorter string to it using UTF-8.
@@ -2174,9 +2084,7 @@ buf.write('some string', 0, 'utf8');
console.log(buf.length);
// Prints: 1234
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` and write a shorter string to it using UTF-8.
@@ -2244,16 +2152,14 @@ Reads an unsigned, big-endian 64-bit integer from `buf` at the specified
This function is also available under the `readBigUint64BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64BE(0));
// Prints: 4294967295n
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
@@ -2275,16 +2181,14 @@ Reads an unsigned, little-endian 64-bit integer from `buf` at the specified
This function is also available under the `readBigUint64LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64LE(0));
// Prints: 18446744069414584320n
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
@@ -2303,16 +2207,14 @@ console.log(buf.readBigUInt64LE(0));
Reads a 64-bit, big-endian double from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleBE(0));
// Prints: 8.20788039913184e-304
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2331,7 +2233,7 @@ console.log(buf.readDoubleBE(0));
Reads a 64-bit, little-endian double from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2340,9 +2242,7 @@ console.log(buf.readDoubleLE(0));
// Prints: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2363,16 +2263,14 @@ console.log(buf.readDoubleLE(1));
Reads a 32-bit, big-endian float from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatBE(0));
// Prints: 2.387939260590663e-38
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2391,7 +2289,7 @@ console.log(buf.readFloatBE(0));
Reads a 32-bit, little-endian float from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2400,9 +2298,7 @@ console.log(buf.readFloatLE(0));
// Prints: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2425,7 +2321,7 @@ Reads a signed 8-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([-1, 5]);
@@ -2436,9 +2332,7 @@ console.log(buf.readInt8(1));
// Prints: 5
console.log(buf.readInt8(2));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([-1, 5]);
@@ -2463,16 +2357,14 @@ Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16BE(0));
// Prints: 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 5]);
@@ -2494,7 +2386,7 @@ Reads a signed, little-endian 16-bit integer from `buf` at the specified
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
@@ -2503,9 +2395,7 @@ console.log(buf.readInt16LE(0));
// Prints: 1280
console.log(buf.readInt16LE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 5]);
@@ -2528,16 +2418,14 @@ Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32BE(0));
// Prints: 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2559,7 +2447,7 @@ Reads a signed, little-endian 32-bit integer from `buf` at the specified
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2568,9 +2456,7 @@ console.log(buf.readInt32LE(0));
// Prints: 83886080
console.log(buf.readInt32LE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2595,7 +2481,7 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as a big-endian, two's complement signed value
supporting up to 48 bits of accuracy.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2606,9 +2492,7 @@ console.log(buf.readIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
console.log(buf.readIntBE(1, 0).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2635,16 +2519,14 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as a little-endian, two's complement signed value
supporting up to 48 bits of accuracy.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntLE(0, 6).toString(16));
// Prints: -546f87a9cbee
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2665,7 +2547,7 @@ Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
This function is also available under the `readUint8` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, -2]);
@@ -2676,9 +2558,7 @@ console.log(buf.readUInt8(1));
// Prints: 254
console.log(buf.readUInt8(2));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, -2]);
@@ -2704,7 +2584,7 @@ Reads an unsigned, big-endian 16-bit integer from `buf` at the specified
This function is also available under the `readUint16BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2713,9 +2593,7 @@ console.log(buf.readUInt16BE(0).toString(16));
// Prints: 1234
console.log(buf.readUInt16BE(1).toString(16));
// Prints: 3456
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2739,7 +2617,7 @@ Reads an unsigned, little-endian 16-bit integer from `buf` at the specified
This function is also available under the `readUint16LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2750,9 +2628,7 @@ console.log(buf.readUInt16LE(1).toString(16));
// Prints: 5634
console.log(buf.readUInt16LE(2).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2778,16 +2654,14 @@ Reads an unsigned, big-endian 32-bit integer from `buf` at the specified
This function is also available under the `readUint32BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32BE(0).toString(16));
// Prints: 12345678
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2809,7 +2683,7 @@ Reads an unsigned, little-endian 32-bit integer from `buf` at the specified
This function is also available under the `readUint32LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2818,9 +2692,7 @@ console.log(buf.readUInt32LE(0).toString(16));
// Prints: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2847,7 +2719,7 @@ up to 48 bits of accuracy.
This function is also available under the `readUintBE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2856,9 +2728,7 @@ console.log(buf.readUIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2885,16 +2755,14 @@ up to 48 bits of accuracy.
This function is also available under the `readUintLE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntLE(0, 6).toString(16));
// Prints: ab9078563412
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2923,7 +2791,7 @@ This method is inherited from [`TypedArray.prototype.subarray()`][].
Modifying the new `Buffer` slice will modify the memory in the original `Buffer`
because the allocated memory of the two objects overlap.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
@@ -2945,9 +2813,7 @@ buf1[0] = 33;
console.log(buf2.toString('ascii', 0, buf2.length));
// Prints: !bc
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
@@ -2974,7 +2840,7 @@ console.log(buf2.toString('ascii', 0, buf2.length));
Specifying negative indexes causes the slice to be generated relative to the
end of `buf` rather than the beginning.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -2990,9 +2856,7 @@ console.log(buf.subarray(-6, -2).toString());
console.log(buf.subarray(-5, -2).toString());
// Prints: uff
// (Equivalent to buf.subarray(1, 4).)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3032,7 +2896,7 @@ This method is not compatible with the `Uint8Array.prototype.slice()`,
which is a superclass of `Buffer`. To copy the slice, use
`Uint8Array.prototype.slice()`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3052,9 +2916,7 @@ console.log(notReallyCopiedBuf.toString());
// Prints: cuffer
console.log(buf.toString());
// Also prints: cuffer (!)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3086,7 +2948,7 @@ Interprets `buf` as an array of unsigned 16-bit integers and swaps the
byte order _in-place_. Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][]
is not a multiple of 2.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3103,9 +2965,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap16();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3127,14 +2987,12 @@ buf2.swap16();
One convenient use of `buf.swap16()` is to perform a fast in-place conversion
between UTF-16 little-endian and UTF-16 big-endian:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
buf.swap16(); // Convert to big-endian UTF-16 text.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
@@ -3151,7 +3009,7 @@ Interprets `buf` as an array of unsigned 32-bit integers and swaps the
byte order _in-place_. Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][]
is not a multiple of 4.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3168,9 +3026,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap32();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3198,7 +3054,7 @@ buf2.swap32();
Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_.
Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][] is not a multiple of 8.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3215,9 +3071,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3248,7 +3102,7 @@ this function when stringifying a `Buffer` instance.
`Buffer.from()` accepts objects in the format returned from this method.
In particular, `Buffer.from(buf.toJSON())` works like `Buffer.from(buf)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
@@ -3265,9 +3119,7 @@ const copy = JSON.parse(json, (key, value) => {
console.log(copy);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
@@ -3305,7 +3157,7 @@ then each invalid byte 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`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.allocUnsafe(26);
@@ -3328,9 +3180,7 @@ console.log(buf2.toString('utf8', 0, 3));
// Prints: té
console.log(buf2.toString(undefined, 0, 3));
// Prints: té
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.allocUnsafe(26);
@@ -3364,7 +3214,7 @@ console.log(buf2.toString(undefined, 0, 3));
Creates and returns an [iterator][] for `buf` values (bytes). This function is
called automatically when a `Buffer` is used in a `for..of` statement.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3390,9 +3240,7 @@ for (const value of buf) {
// 102
// 101
// 114
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3437,7 +3285,7 @@ Writes `string` to `buf` at `offset` according to the character encoding in
not contain enough space to fit the entire string, only part of `string` will be
written. However, partially encoded characters will not be written.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(256);
@@ -3453,9 +3301,7 @@ const length = buffer.write('abcd', 8);
console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// Prints: 2 bytes : ab
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(256);
@@ -3486,7 +3332,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3495,9 +3341,7 @@ buf.writeBigInt64BE(0x0102030405060708n, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3521,7 +3365,7 @@ Writes `value` to `buf` at the specified `offset` as little-endian.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3530,9 +3374,7 @@ buf.writeBigInt64LE(0x0102030405060708n, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3556,7 +3398,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian.
This function is also available under the `writeBigUint64BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3565,9 +3407,7 @@ buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3589,7 +3429,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as little-endian
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3598,9 +3438,7 @@ buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3626,7 +3464,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian. The `value`
must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3635,9 +3473,7 @@ buf.writeDoubleBE(123.456, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3661,7 +3497,7 @@ Writes `value` to `buf` at the specified `offset` as little-endian. The `value`
must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3670,9 +3506,7 @@ buf.writeDoubleLE(123.456, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3695,7 +3529,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3704,9 +3538,7 @@ buf.writeFloatBE(0xcafebabe, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3729,7 +3561,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3738,9 +3570,7 @@ buf.writeFloatLE(0xcafebabe, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3766,7 +3596,7 @@ a signed 8-bit integer.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3776,9 +3606,7 @@ buf.writeInt8(-2, 1);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3805,7 +3633,7 @@ anything other than a signed 16-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3814,9 +3642,7 @@ buf.writeInt16BE(0x0102, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3842,7 +3668,7 @@ anything other than a signed 16-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3851,9 +3677,7 @@ buf.writeInt16LE(0x0304, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3879,7 +3703,7 @@ anything other than a signed 32-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3888,9 +3712,7 @@ buf.writeInt32BE(0x01020304, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3916,7 +3738,7 @@ anything other than a signed 32-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3925,9 +3747,7 @@ buf.writeInt32LE(0x05060708, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3953,7 +3773,7 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when
`value` is anything other than a signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -3962,9 +3782,7 @@ buf.writeIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -3990,7 +3808,7 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than a signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -3999,9 +3817,7 @@ buf.writeIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4027,7 +3843,7 @@ other than an unsigned 8-bit integer.
This function is also available under the `writeUint8` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4039,9 +3855,7 @@ buf.writeUInt8(0x42, 3);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4070,7 +3884,7 @@ is anything other than an unsigned 16-bit integer.
This function is also available under the `writeUint16BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4080,9 +3894,7 @@ buf.writeUInt16BE(0xbeef, 2);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4109,7 +3921,7 @@ anything other than an unsigned 16-bit integer.
This function is also available under the `writeUint16LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4119,9 +3931,7 @@ buf.writeUInt16LE(0xbeef, 2);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4148,7 +3958,7 @@ is anything other than an unsigned 32-bit integer.
This function is also available under the `writeUint32BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4157,9 +3967,7 @@ buf.writeUInt32BE(0xfeedface, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4185,7 +3993,7 @@ anything other than an unsigned 32-bit integer.
This function is also available under the `writeUint32LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4194,9 +4002,7 @@ buf.writeUInt32LE(0xfeedface, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4224,7 +4030,7 @@ when `value` is anything other than an unsigned integer.
This function is also available under the `writeUintBE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4233,9 +4039,7 @@ buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4263,7 +4067,7 @@ when `value` is anything other than an unsigned integer.
This function is also available under the `writeUintLE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4272,9 +4076,7 @@ buf.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4481,15 +4283,13 @@ Encodings supported by `buffer.transcode()` are: `'ascii'`, `'utf8'`,
The transcoding process will use substitution characters if a given byte
sequence cannot be adequately represented in the target encoding. For instance:
-```mjs
+```mjs|cjs
import { Buffer, transcode } from 'node:buffer';
const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
console.log(newBuf.toString('ascii'));
// Prints: '?'
-```
-
-```cjs
+--------------
const { Buffer, transcode } = require('node:buffer');
const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
diff --git a/content/api/v16/child_process.en.md b/content/api/v16/child_process.en.md
index 57dca36cc1..07133468c5 100644
--- a/content/api/v16/child_process.en.md
+++ b/content/api/v16/child_process.en.md
@@ -13,7 +13,7 @@ Stable
-
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const spkac = getSpkacSomehow();
const publicKey = Certificate.exportPublicKey(spkac);
@@ -151,16 +145,14 @@ console.log(publicKey);
* Returns: [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) `true` if the given `spkac` data structure is valid,
`false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { Certificate } = await import('node:crypto');
const spkac = getSpkacSomehow();
console.log(Certificate.verifySpkac(Buffer.from(spkac)));
// Prints: true or false
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const { Buffer } = require('node:buffer');
@@ -185,14 +177,12 @@ the `crypto.Certificate` class as illustrated in the examples below.
Instances of the `Certificate` class can be created using the `new` keyword
or by calling `crypto.Certificate()` as a function:
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert1 = new Certificate();
const cert2 = Certificate();
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert1 = new Certificate();
@@ -208,16 +198,14 @@ const cert2 = Certificate();
* Returns: [`Buffer`](/api/v16/buffer#buffer) The challenge component of the `spkac` data structure, which
includes a public key and a challenge.
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
const challenge = cert.exportChallenge(spkac);
console.log(challenge.toString('utf8'));
// Prints: the challenge as a UTF8 string
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -235,16 +223,14 @@ console.log(challenge.toString('utf8'));
* Returns: [`Buffer`](/api/v16/buffer#buffer) The public key component of the `spkac` data structure,
which includes a public key and a challenge.
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
const publicKey = cert.exportPublicKey(spkac);
console.log(publicKey);
// Prints: the public key as
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -262,7 +248,7 @@ console.log(publicKey);
* Returns: [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) `true` if the given `spkac` data structure is valid,
`false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { Certificate } = await import('node:crypto');
@@ -270,9 +256,7 @@ const cert = Certificate();
const spkac = getSpkacSomehow();
console.log(cert.verifySpkac(Buffer.from(spkac)));
// Prints: true or false
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const { Buffer } = require('node:buffer');
@@ -302,7 +286,7 @@ directly using the `new` keyword.
Example: Using `Cipher` objects as streams:
-```mjs
+```mjs|cjs
const {
scrypt,
randomFill,
@@ -333,9 +317,7 @@ scrypt(password, 'salt', 24, (err, key) => {
cipher.end();
});
});
-```
-
-```cjs
+--------------
const {
scrypt,
randomFill,
@@ -370,7 +352,7 @@ scrypt(password, 'salt', 24, (err, key) => {
Example: Using `Cipher` and piped streams:
-```mjs
+```mjs|cjs
import {
createReadStream,
createWriteStream,
@@ -407,9 +389,7 @@ scrypt(password, 'salt', 24, (err, key) => {
});
});
});
-```
-
-```cjs
+--------------
const {
createReadStream,
createWriteStream,
@@ -450,7 +430,7 @@ scrypt(password, 'salt', 24, (err, key) => {
Example: Using the [`cipher.update()`][] and [`cipher.final()`][] methods:
-```mjs
+```mjs|cjs
const {
scrypt,
randomFill,
@@ -475,9 +455,7 @@ scrypt(password, 'salt', 24, (err, key) => {
console.log(encrypted);
});
});
-```
-
-```cjs
+--------------
const {
scrypt,
randomFill,
@@ -618,7 +596,7 @@ directly using the `new` keyword.
Example: Using `Decipher` objects as streams:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
scryptSync,
@@ -653,9 +631,7 @@ const encrypted =
'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';
decipher.write(encrypted, 'hex');
decipher.end();
-```
-
-```cjs
+--------------
const {
scryptSync,
createDecipheriv,
@@ -694,7 +670,7 @@ decipher.end();
Example: Using `Decipher` and piped streams:
-```mjs
+```mjs|cjs
import {
createReadStream,
createWriteStream,
@@ -718,9 +694,7 @@ const input = createReadStream('test.enc');
const output = createWriteStream('test.js');
input.pipe(decipher).pipe(output);
-```
-
-```cjs
+--------------
const {
createReadStream,
createWriteStream,
@@ -748,7 +722,7 @@ input.pipe(decipher).pipe(output);
Example: Using the [`decipher.update()`][] and [`decipher.final()`][] methods:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
scryptSync,
@@ -771,9 +745,7 @@ let decrypted = decipher.update(encrypted, 'hex', 'utf8');
decrypted += decipher.final('utf8');
console.log(decrypted);
// Prints: some clear text data
-```
-
-```cjs
+--------------
const {
scryptSync,
createDecipheriv,
@@ -911,7 +883,7 @@ exchanges.
Instances of the `DiffieHellman` class can be created using the
[`crypto.createDiffieHellman()`][] function.
-```mjs
+```mjs|cjs
import assert from 'node:assert';
const {
@@ -932,9 +904,7 @@ const bobSecret = bob.computeSecret(aliceKey);
// OK
assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
-```
-
-```cjs
+--------------
const assert = require('node:assert');
const {
@@ -984,12 +954,17 @@ If `outputEncoding` is given a string is returned; otherwise, a
* `encoding` [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) The [encoding][] of the return value.
* Returns: [`Buffer`](/api/v16/buffer#buffer) | [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
-Generates private and public Diffie-Hellman key values, and returns
+Generates private and public Diffie-Hellman key values unless they have been
+generated or computed already, and returns
the public key in the specified `encoding`. This key should be
transferred to the other party.
If `encoding` is provided a string is returned; otherwise a
[`Buffer`][] is returned.
+This function is a thin wrapper around [`DH_generate_key()`][]. In particular,
+once a private key has been generated or set, calling this function only updates
+the public key but does not generate a new private key.
+
####
napi_value create_addon(napi_env env);
#endif // _ADDON_H_
-```
-
-```c
+--------------
// addon.c
#include "addon.h"
@@ -5732,12 +5728,10 @@ Experimental
-```c
+```c|text
NAPI_EXTERN napi_status
node_api_get_module_file_name(napi_env env, const char** result);
-```
-
* `[in] env`: The environment that the API is invoked under.
* `[out] result`: A URL containing the absolute path of the
location from which the add-on was loaded. For a file on the local
diff --git a/content/api/v16/navigation.json b/content/api/v16/navigation.json
index ffcac50f87..fb563b0c1b 100644
--- a/content/api/v16/navigation.json
+++ b/content/api/v16/navigation.json
@@ -1,4 +1,1571 @@
{
"version": "v16",
- "items": []
+ "items": [
+ {
+ "slug": "/api/v16/addons/",
+ "title": "C addons",
+ "type": "module",
+ "name": "addons"
+ },
+ {
+ "slug": "/api/v16/assert/",
+ "title": "Assert",
+ "type": "module",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v16/assert/#assertassertionerror",
+ "title": "assertAssertionError",
+ "type": "class",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v16/assert/#assertcalltracker",
+ "title": "assertCallTracker",
+ "type": "class",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v16/async_context/",
+ "title": "Asynchronous context tracking",
+ "type": "module",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v16/async_context/#asynclocalstorage",
+ "title": "AsyncLocalStorage",
+ "type": "class",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v16/async_context/#asyncresource",
+ "title": "AsyncResource",
+ "type": "class",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v16/async_hooks/",
+ "title": "Async hooks",
+ "type": "module",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v16/async_hooks/#asynchook",
+ "title": "AsyncHook",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v16/async_hooks/#asynclocalstorage",
+ "title": "AsyncLocalStorage",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v16/async_hooks/#asyncresource",
+ "title": "AsyncResource",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v16/buffer/",
+ "title": "Buffer",
+ "type": "module",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v16/buffer/#blob",
+ "title": "Blob",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v16/buffer/#buffer",
+ "title": "Buffer",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v16/buffer/#slowbuffer",
+ "title": "SlowBuffer",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v16/child_process/",
+ "title": "Child process",
+ "type": "module",
+ "name": "child_process"
+ },
+ {
+ "slug": "/api/v16/child_process/#childprocess",
+ "title": "ChildProcess",
+ "type": "class",
+ "name": "child_process"
+ },
+ {
+ "slug": "/api/v16/cli/",
+ "title": "Command-line API",
+ "type": "module",
+ "name": "cli"
+ },
+ {
+ "slug": "/api/v16/cluster/",
+ "title": "Cluster",
+ "type": "module",
+ "name": "cluster"
+ },
+ {
+ "slug": "/api/v16/cluster/#worker",
+ "title": "Worker",
+ "type": "class",
+ "name": "cluster"
+ },
+ {
+ "slug": "/api/v16/console/",
+ "title": "Console",
+ "type": "module",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v16/console/#console",
+ "title": "Console",
+ "type": "class",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v16/console/#console",
+ "title": "Console",
+ "type": "class",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v16/corepack/",
+ "title": "Corepack",
+ "type": "module",
+ "name": "corepack"
+ },
+ {
+ "slug": "/api/v16/crypto/",
+ "title": "Crypto",
+ "type": "module",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#certificate",
+ "title": "Certificate",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#cipher",
+ "title": "Cipher",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#decipher",
+ "title": "Decipher",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#diffiehellman",
+ "title": "DiffieHellman",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#diffiehellmangroup",
+ "title": "DiffieHellmanGroup",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#ecdh",
+ "title": "ECDH",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#hash",
+ "title": "Hash",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#hmac",
+ "title": "Hmac",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#keyobject",
+ "title": "KeyObject",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#sign",
+ "title": "Sign",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#verify",
+ "title": "Verify",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/crypto/#x509certificate",
+ "title": "X509Certificate",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v16/debugger/",
+ "title": "Debugger",
+ "type": "module",
+ "name": "debugger"
+ },
+ {
+ "slug": "/api/v16/deprecations/",
+ "title": "Deprecated APIs",
+ "type": "module",
+ "name": "deprecations"
+ },
+ {
+ "slug": "/api/v16/dgram/",
+ "title": "UDPdatagram sockets",
+ "type": "module",
+ "name": "dgram"
+ },
+ {
+ "slug": "/api/v16/dgram/#dgramsocket",
+ "title": "dgramSocket",
+ "type": "class",
+ "name": "dgram"
+ },
+ {
+ "slug": "/api/v16/diagnostics_channel/",
+ "title": "Diagnostics Channel",
+ "type": "module",
+ "name": "diagnostics_channel"
+ },
+ {
+ "slug": "/api/v16/diagnostics_channel/#channel",
+ "title": "Channel",
+ "type": "class",
+ "name": "diagnostics_channel"
+ },
+ {
+ "slug": "/api/v16/dns/",
+ "title": "DNS",
+ "type": "module",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v16/dns/#dnspromisesresolver",
+ "title": "dnsPromisesResolver",
+ "type": "class",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v16/dns/#dnsresolver",
+ "title": "dnsResolver",
+ "type": "class",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v16/documentation/",
+ "title": "About this documentation",
+ "type": "module",
+ "name": "documentation"
+ },
+ {
+ "slug": "/api/v16/domain/",
+ "title": "Domain",
+ "type": "module",
+ "name": "domain"
+ },
+ {
+ "slug": "/api/v16/domain/#domain",
+ "title": "Domain",
+ "type": "class",
+ "name": "domain"
+ },
+ {
+ "slug": "/api/v16/embedding/",
+ "title": "C embedder API",
+ "type": "module",
+ "name": "embedding"
+ },
+ {
+ "slug": "/api/v16/errors/",
+ "title": "Errors",
+ "type": "module",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/errors/#assertionerror",
+ "title": "AssertionError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/errors/#error",
+ "title": "Error",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/errors/#rangeerror",
+ "title": "RangeError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/errors/#referenceerror",
+ "title": "ReferenceError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/errors/#syntaxerror",
+ "title": "SyntaxError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/errors/#systemerror",
+ "title": "SystemError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/errors/#typeerror",
+ "title": "TypeError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v16/esm/",
+ "title": "ECMAScript modules",
+ "type": "module",
+ "name": "esm"
+ },
+ {
+ "slug": "/api/v16/events/",
+ "title": "Events",
+ "type": "module",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v16/events/#customevent",
+ "title": "CustomEvent",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v16/events/#event",
+ "title": "Event",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v16/events/#eventemitter",
+ "title": "EventEmitter",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v16/events/#eventseventemitterasyncresource-extends-eventemitter",
+ "title": "eventsEventEmitterAsyncResource extends EventEmitter",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v16/events/#eventtarget",
+ "title": "EventTarget",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v16/events/#nodeeventtarget",
+ "title": "NodeEventTarget",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v16/fs/",
+ "title": "File system",
+ "type": "module",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#filehandle",
+ "title": "FileHandle",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#fsdir",
+ "title": "fsDir",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#fsdirent",
+ "title": "fsDirent",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#fsfswatcher",
+ "title": "fsFSWatcher",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#fsreadstream",
+ "title": "fsReadStream",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#fsstats",
+ "title": "fsStats",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#fsstatwatcher",
+ "title": "fsStatWatcher",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/fs/#fswritestream",
+ "title": "fsWriteStream",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v16/globals/",
+ "title": "Global objects",
+ "type": "module",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#abortcontroller",
+ "title": "AbortController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#abortcontroller",
+ "title": "AbortController",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#abortsignal",
+ "title": "AbortSignal",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#buffer",
+ "title": "Buffer",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#buffer",
+ "title": "Buffer",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#clearimmediateimmediateobject",
+ "title": "clearImmediate",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#clearintervalintervalobject",
+ "title": "clearInterval",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#cleartimeouttimeoutobject",
+ "title": "clearTimeout",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#console",
+ "title": "console",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#customevent",
+ "title": "CustomEvent",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#event",
+ "title": "Event",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#eventtarget",
+ "title": "EventTarget",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#global",
+ "title": "global",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#messagechannel",
+ "title": "MessageChannel",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#messageevent",
+ "title": "MessageEvent",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#messageport",
+ "title": "MessagePort",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#process",
+ "title": "process",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#queuemicrotaskcallback",
+ "title": "queueMicrotask",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#setimmediatecallback-args",
+ "title": "setImmediate",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#setintervalcallback-delay-args",
+ "title": "setInterval",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#settimeoutcallback-delay-args",
+ "title": "setTimeout",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#textdecoder",
+ "title": "TextDecoder",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#textencoder",
+ "title": "TextEncoder",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#url",
+ "title": "URL",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#urlsearchparams",
+ "title": "URLSearchParams",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/globals/#webassembly",
+ "title": "WebAssembly",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v16/http/",
+ "title": "HTTP",
+ "type": "module",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v16/http/#httpagent",
+ "title": "httpAgent",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v16/http/#httpclientrequest",
+ "title": "httpClientRequest",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v16/http/#httpincomingmessage",
+ "title": "httpIncomingMessage",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v16/http/#httpoutgoingmessage",
+ "title": "httpOutgoingMessage",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v16/http/#httpserver",
+ "title": "httpServer",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v16/http/#httpserverresponse",
+ "title": "httpServerResponse",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v16/http2/",
+ "title": "HTTP2",
+ "type": "module",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#clienthttp2session",
+ "title": "ClientHttp2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#clienthttp2stream",
+ "title": "ClientHttp2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#http2http2serverrequest",
+ "title": "http2Http2ServerRequest",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#http2http2serverresponse",
+ "title": "http2Http2ServerResponse",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#http2secureserver",
+ "title": "Http2SecureServer",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#http2server",
+ "title": "Http2Server",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#http2session",
+ "title": "Http2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#http2stream",
+ "title": "Http2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#serverhttp2session",
+ "title": "ServerHttp2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/http2/#serverhttp2stream",
+ "title": "ServerHttp2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v16/https/",
+ "title": "HTTPS",
+ "type": "module",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v16/https/#httpsagent",
+ "title": "httpsAgent",
+ "type": "class",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v16/https/#httpsserver",
+ "title": "httpsServer",
+ "type": "class",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v16/inspector/",
+ "title": "Inspector",
+ "type": "module",
+ "name": "inspector"
+ },
+ {
+ "slug": "/api/v16/inspector/#inspectorsession",
+ "title": "inspectorSession",
+ "type": "class",
+ "name": "inspector"
+ },
+ {
+ "slug": "/api/v16/intl/",
+ "title": "Internationalization support",
+ "type": "module",
+ "name": "intl"
+ },
+ {
+ "slug": "/api/v16/module/",
+ "title": "nodemodule API",
+ "type": "module",
+ "name": "module"
+ },
+ {
+ "slug": "/api/v16/module/#modulesourcemap",
+ "title": "moduleSourceMap",
+ "type": "class",
+ "name": "module"
+ },
+ {
+ "slug": "/api/v16/modules/",
+ "title": "CommonJS modules",
+ "type": "module",
+ "name": "modules"
+ },
+ {
+ "slug": "/api/v16/n-api/",
+ "title": "Node-API",
+ "type": "module",
+ "name": "n-api"
+ },
+ {
+ "slug": "/api/v16/net/",
+ "title": "Net",
+ "type": "module",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v16/net/#netblocklist",
+ "title": "netBlockList",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v16/net/#netserver",
+ "title": "netServer",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v16/net/#netsocket",
+ "title": "netSocket",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v16/net/#netsocketaddress",
+ "title": "netSocketAddress",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v16/os/",
+ "title": "OS",
+ "type": "module",
+ "name": "os"
+ },
+ {
+ "slug": "/api/v16/packages/",
+ "title": "Packages",
+ "type": "module",
+ "name": "packages"
+ },
+ {
+ "slug": "/api/v16/path/",
+ "title": "Path",
+ "type": "module",
+ "name": "path"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/",
+ "title": "Performance measurement APIs",
+ "type": "module",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#histogram",
+ "title": "Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#intervalhistogram-extends-histogram",
+ "title": "IntervalHistogram extends Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#perf-hooksperformanceobserver",
+ "title": "perf_hooksPerformanceObserver",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#performanceentry",
+ "title": "PerformanceEntry",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#performancenodetiming",
+ "title": "PerformanceNodeTiming",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#performanceobserverentrylist",
+ "title": "PerformanceObserverEntryList",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#performanceresourcetiming",
+ "title": "PerformanceResourceTiming",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/perf_hooks/#recordablehistogram-extends-histogram",
+ "title": "RecordableHistogram extends Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v16/permissions/",
+ "title": "Permissions",
+ "type": "module",
+ "name": "permissions"
+ },
+ {
+ "slug": "/api/v16/policy/",
+ "title": "Policies",
+ "type": "module",
+ "name": "policy"
+ },
+ {
+ "slug": "/api/v16/process/",
+ "title": "Process",
+ "type": "module",
+ "name": "process"
+ },
+ {
+ "slug": "/api/v16/punycode/",
+ "title": "Punycode",
+ "type": "module",
+ "name": "punycode"
+ },
+ {
+ "slug": "/api/v16/querystring/",
+ "title": "Query string",
+ "type": "module",
+ "name": "querystring"
+ },
+ {
+ "slug": "/api/v16/readline/",
+ "title": "Readline",
+ "type": "module",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v16/readline/#interface",
+ "title": "Interface",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v16/repl/",
+ "title": "REPL",
+ "type": "module",
+ "name": "repl"
+ },
+ {
+ "slug": "/api/v16/repl/#replserver",
+ "title": "REPLServer",
+ "type": "class",
+ "name": "repl"
+ },
+ {
+ "slug": "/api/v16/report/",
+ "title": "Diagnostic report",
+ "type": "module",
+ "name": "report"
+ },
+ {
+ "slug": "/api/v16/stream/",
+ "title": "Stream",
+ "type": "module",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamduplex",
+ "title": "streamDuplex",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamduplex",
+ "title": "streamDuplex",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streampassthrough",
+ "title": "streamPassThrough",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamreadable",
+ "title": "streamReadable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamreadable",
+ "title": "streamReadable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamtransform",
+ "title": "streamTransform",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamtransform",
+ "title": "streamTransform",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamwritable",
+ "title": "streamWritable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/stream/#streamwritable",
+ "title": "streamWritable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v16/string_decoder/",
+ "title": "String decoder",
+ "type": "module",
+ "name": "string_decoder"
+ },
+ {
+ "slug": "/api/v16/string_decoder/#stringdecoder",
+ "title": "StringDecoder",
+ "type": "class",
+ "name": "string_decoder"
+ },
+ {
+ "slug": "/api/v16/synopsis/",
+ "title": "Usage and example",
+ "type": "module",
+ "name": "synopsis"
+ },
+ {
+ "slug": "/api/v16/test/",
+ "title": "Test runner",
+ "type": "module",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v16/test/#suitecontext",
+ "title": "SuiteContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v16/test/#tapstream",
+ "title": "TapStream",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v16/test/#testcontext",
+ "title": "TestContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v16/timers/",
+ "title": "Timers",
+ "type": "module",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v16/timers/#immediate",
+ "title": "Immediate",
+ "type": "class",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v16/timers/#timeout",
+ "title": "Timeout",
+ "type": "class",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v16/tls/",
+ "title": "TLS ",
+ "type": "module",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v16/tls/#tlscryptostream",
+ "title": "tlsCryptoStream",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v16/tls/#tlssecurepair",
+ "title": "tlsSecurePair",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v16/tls/#tlsserver",
+ "title": "tlsServer",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v16/tls/#tlstlssocket",
+ "title": "tlsTLSSocket",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v16/tracing/",
+ "title": "Trace events",
+ "type": "module",
+ "name": "tracing"
+ },
+ {
+ "slug": "/api/v16/tty/",
+ "title": "TTY",
+ "type": "module",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v16/tty/#ttyreadstream",
+ "title": "ttyReadStream",
+ "type": "class",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v16/tty/#ttywritestream",
+ "title": "ttyWriteStream",
+ "type": "class",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v16/url/",
+ "title": "URL",
+ "type": "module",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v16/url/#url",
+ "title": "URL",
+ "type": "class",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v16/url/#urlsearchparams",
+ "title": "URLSearchParams",
+ "type": "class",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v16/util/",
+ "title": "Util",
+ "type": "module",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v16/util/#utiltextdecoder",
+ "title": "utilTextDecoder",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v16/util/#utiltextencoder",
+ "title": "utilTextEncoder",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v16/v8/",
+ "title": "V8",
+ "type": "module",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v16/v8/#v8defaultdeserializer",
+ "title": "v8DefaultDeserializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v16/v8/#v8defaultserializer",
+ "title": "v8DefaultSerializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v16/v8/#v8deserializer",
+ "title": "v8Deserializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v16/v8/#v8serializer",
+ "title": "v8Serializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v16/vm/",
+ "title": "VM ",
+ "type": "module",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v16/vm/#vmmodule",
+ "title": "vmModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v16/vm/#vmscript",
+ "title": "vmScript",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v16/vm/#vmsourcetextmodule",
+ "title": "vmSourceTextModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v16/vm/#vmsyntheticmodule",
+ "title": "vmSyntheticModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v16/wasi/",
+ "title": "WebAssembly System Interface ",
+ "type": "module",
+ "name": "wasi"
+ },
+ {
+ "slug": "/api/v16/wasi/#wasi",
+ "title": "WASI",
+ "type": "class",
+ "name": "wasi"
+ },
+ {
+ "slug": "/api/v16/webcrypto/",
+ "title": "Web Crypto API",
+ "type": "module",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#aescbcparams",
+ "title": "AesCbcParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#aesctrparams",
+ "title": "AesCtrParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#aesgcmparams",
+ "title": "AesGcmParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#aeskeygenparams",
+ "title": "AesKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#algorithmidentifier",
+ "title": "AlgorithmIdentifier",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#crypto",
+ "title": "Crypto",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#cryptokey",
+ "title": "CryptoKey",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#cryptokeypair",
+ "title": "CryptoKeyPair",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#ecdhkeyderiveparams",
+ "title": "EcdhKeyDeriveParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#ecdsaparams",
+ "title": "EcdsaParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#eckeygenparams",
+ "title": "EcKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#eckeyimportparams",
+ "title": "EcKeyImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#ed448params",
+ "title": "Ed448Params",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#hkdfparams",
+ "title": "HkdfParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#hmacimportparams",
+ "title": "HmacImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#hmackeygenparams",
+ "title": "HmacKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#pbkdf2params",
+ "title": "Pbkdf2Params",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#rsahashedimportparams",
+ "title": "RsaHashedImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#rsahashedkeygenparams",
+ "title": "RsaHashedKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#rsaoaepparams",
+ "title": "RsaOaepParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#rsapssparams",
+ "title": "RsaPssParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webcrypto/#subtlecrypto",
+ "title": "SubtleCrypto",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v16/webstreams/",
+ "title": "Web Streams API",
+ "type": "module",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#bytelengthqueuingstrategy",
+ "title": "ByteLengthQueuingStrategy",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#countqueuingstrategy",
+ "title": "CountQueuingStrategy",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#readablebytestreamcontroller",
+ "title": "ReadableByteStreamController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#readablestream",
+ "title": "ReadableStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#readablestreambyobreader",
+ "title": "ReadableStreamBYOBReader",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#readablestreambyobrequest",
+ "title": "ReadableStreamBYOBRequest",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#readablestreamdefaultcontroller",
+ "title": "ReadableStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#readablestreamdefaultreader",
+ "title": "ReadableStreamDefaultReader",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#textdecoderstream",
+ "title": "TextDecoderStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#textencoderstream",
+ "title": "TextEncoderStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#transformstream",
+ "title": "TransformStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#transformstreamdefaultcontroller",
+ "title": "TransformStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#writablestream",
+ "title": "WritableStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#writablestreamdefaultcontroller",
+ "title": "WritableStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/webstreams/#writablestreamdefaultwriter",
+ "title": "WritableStreamDefaultWriter",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v16/worker_threads/",
+ "title": "Worker threads",
+ "type": "module",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v16/worker_threads/#broadcastchannel-extends-eventtarget",
+ "title": "BroadcastChannel extends EventTarget",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v16/worker_threads/#messagechannel",
+ "title": "MessageChannel",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v16/worker_threads/#messageport",
+ "title": "MessagePort",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v16/worker_threads/#worker",
+ "title": "Worker",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v16/zlib/",
+ "title": "Zlib",
+ "type": "module",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#brotlioptions",
+ "title": "BrotliOptions",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#options",
+ "title": "Options",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibbrotlicompress",
+ "title": "zlibBrotliCompress",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibbrotlidecompress",
+ "title": "zlibBrotliDecompress",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibdeflate",
+ "title": "zlibDeflate",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibdeflateraw",
+ "title": "zlibDeflateRaw",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibgunzip",
+ "title": "zlibGunzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibgzip",
+ "title": "zlibGzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibinflate",
+ "title": "zlibInflate",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibinflateraw",
+ "title": "zlibInflateRaw",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibunzip",
+ "title": "zlibUnzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v16/zlib/#zlibzlibbase",
+ "title": "zlibZlibBase",
+ "type": "class",
+ "name": "zlib"
+ }
+ ]
}
\ No newline at end of file
diff --git a/content/api/v16/net.en.md b/content/api/v16/net.en.md
index 8961601604..fee71c3ff7 100644
--- a/content/api/v16/net.en.md
+++ b/content/api/v16/net.en.md
@@ -13,7 +13,7 @@ Stable
-)
// at main (*)
// First call
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('multipleResolves', (type, promise, reason) => {
@@ -291,7 +281,7 @@ In asynchronous code, the `'unhandledRejection'` event is emitted when the list
of unhandled rejections grows, and the `'rejectionHandled'` event is emitted
when the list of unhandled rejections shrinks.
-```mjs
+```mjs|cjs
import process from 'node:process';
const unhandledRejections = new Map();
@@ -301,9 +291,7 @@ process.on('unhandledRejection', (reason, promise) => {
process.on('rejectionHandled', (promise) => {
unhandledRejections.delete(promise);
});
-```
-
-```cjs
+--------------
const process = require('node:process');
const unhandledRejections = new Map();
@@ -344,7 +332,7 @@ behavior. Alternatively, change the [`process.exitCode`][] in the
provided exit code. Otherwise, in the presence of such handler the process will
exit with 0.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('uncaughtException', (err, origin) => {
@@ -362,9 +350,7 @@ setTimeout(() => {
// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
console.log('This will not run.');
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('uncaughtException', (err, origin) => {
@@ -436,7 +422,7 @@ Installing an `'uncaughtExceptionMonitor'` listener does not change the behavior
once an `'uncaughtException'` event is emitted. The process will
still crash if no `'uncaughtException'` listener is installed.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('uncaughtExceptionMonitor', (err, origin) => {
@@ -446,9 +432,7 @@ process.on('uncaughtExceptionMonitor', (err, origin) => {
// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
// Still crashes Node.js
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('uncaughtExceptionMonitor', (err, origin) => {
@@ -476,7 +460,7 @@ are propagated through a `Promise` chain. The `'unhandledRejection'` event is
useful for detecting and keeping track of promises that were rejected whose
rejections have not yet been handled.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('unhandledRejection', (reason, promise) => {
@@ -487,9 +471,7 @@ process.on('unhandledRejection', (reason, promise) => {
somePromise.then((res) => {
return reportToUser(JSON.pasre(res)); // Note the typo (`pasre`)
}); // No `.catch()` or `.then()`
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('unhandledRejection', (reason, promise) => {
@@ -505,7 +487,7 @@ somePromise.then((res) => {
The following will also trigger the `'unhandledRejection'` event to be
emitted:
-```mjs
+```mjs|cjs
import process from 'node:process';
function SomeResource() {
@@ -515,9 +497,7 @@ function SomeResource() {
const resource = new SomeResource();
// no .catch or .then on resource.loaded for at least a turn
-```
-
-```cjs
+--------------
const process = require('node:process');
function SomeResource() {
@@ -554,7 +534,7 @@ are not part of the normal Node.js and JavaScript error handling flow.
Node.js can emit warnings whenever it detects bad coding practices that could
lead to sub-optimal application performance, bugs, or security vulnerabilities.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('warning', (warning) => {
@@ -562,9 +542,7 @@ process.on('warning', (warning) => {
console.warn(warning.message); // Print the warning message
console.warn(warning.stack); // Print the stack trace
});
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('warning', (warning) => {
@@ -671,7 +649,7 @@ The signal handler will receive the signal's name (`'SIGINT'`,
The name of each event will be the uppercase common name for the signal (e.g.
`'SIGINT'` for `SIGINT` signals).
-```mjs
+```mjs|cjs
import process from 'node:process';
// Begin reading from stdin so the process does not exit.
@@ -688,9 +666,7 @@ function handle(signal) {
process.on('SIGINT', handle);
process.on('SIGTERM', handle);
-```
-
-```cjs
+--------------
const process = require('node:process');
// Begin reading from stdin so the process does not exit.
@@ -793,7 +769,7 @@ appear only _once_; each will begin with one or more dashes. Flags
passed through to V8 will contain underscores instead of non-leading
dashes:
-```mjs
+```mjs|cjs
import { allowedNodeEnvironmentFlags } from 'node:process';
allowedNodeEnvironmentFlags.forEach((flag) => {
@@ -802,9 +778,7 @@ allowedNodeEnvironmentFlags.forEach((flag) => {
// --abort_on_uncaught_exception
// ...
});
-```
-
-```cjs
+--------------
const { allowedNodeEnvironmentFlags } = require('node:process');
allowedNodeEnvironmentFlags.forEach((flag) => {
@@ -833,13 +807,11 @@ The operating system CPU architecture for which the Node.js binary was compiled.
Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`,
`'ppc64'`, `'s390'`, `'s390x'`, and `'x64'`.
-```mjs
+```mjs|cjs
import { arch } from 'node:process';
console.log(`This processor architecture is ${arch}`);
-```
-
-```cjs
+--------------
const { arch } = require('node:process');
console.log(`This processor architecture is ${arch}`);
@@ -860,16 +832,14 @@ arguments.
For example, assuming the following script for `process-args.js`:
-```mjs
+```mjs|cjs
import { argv } from 'node:process';
// print process.argv
argv.forEach((val, index) => {
console.log(`${index}: ${val}`);
});
-```
-
-```cjs
+--------------
const { argv } = require('node:process');
// print process.argv
@@ -954,7 +924,7 @@ The `process.chdir()` method changes the current working directory of the
Node.js process or throws an exception if doing so fails (for instance, if
the specified `directory` does not exist).
-```mjs
+```mjs|cjs
import { chdir, cwd } from 'node:process';
console.log(`Starting directory: ${cwd()}`);
@@ -964,9 +934,7 @@ try {
} catch (err) {
console.error(`chdir: ${err}`);
}
-```
-
-```cjs
+--------------
const { chdir, cwd } = require('node:process');
console.log(`Starting directory: ${cwd()}`);
@@ -1062,7 +1030,7 @@ actual elapsed time if multiple CPU cores are performing work for this process.
The result of a previous call to `process.cpuUsage()` can be passed as the
argument to the function, to get a diff reading.
-```mjs
+```mjs|cjs
import { cpuUsage } from 'node:process';
const startUsage = cpuUsage();
@@ -1074,9 +1042,7 @@ while (Date.now() - now < 500);
console.log(cpuUsage(startUsage));
// { user: 514883, system: 11226 }
-```
-
-```cjs
+--------------
const { cpuUsage } = require('node:process');
const startUsage = cpuUsage();
@@ -1099,13 +1065,11 @@ console.log(cpuUsage(startUsage));
The `process.cwd()` method returns the current working directory of the Node.js
process.
-```mjs
+```mjs|cjs
import { cwd } from 'node:process';
console.log(`Current directory: ${cwd()}`);
-```
-
-```cjs
+--------------
const { cwd } = require('node:process');
console.log(`Current directory: ${cwd()}`);
@@ -1119,13 +1083,11 @@ console.log(`Current directory: ${cwd()}`);
The port used by the Node.js debugger when enabled.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.debugPort = 5858;
-```
-
-```cjs
+--------------
const process = require('node:process');
process.debugPort = 5858;
@@ -1172,7 +1134,7 @@ that exports a `foo` function. All the symbols are loaded before
the call returns, by passing the `RTLD_NOW` constant. In this example
the constant is assumed to be available.
-```mjs
+```mjs|cjs
import { dlopen } from 'node:process';
import { constants } from 'node:os';
import { fileURLToPath } from 'node:url';
@@ -1181,9 +1143,7 @@ const module = { exports: {} };
dlopen(module, fileURLToPath(new URL('local.node', import.meta.url)),
constants.dlopen.RTLD_NOW);
module.exports.foo();
-```
-
-```cjs
+--------------
const { dlopen } = require('node:process');
const { constants } = require('node:os');
const { join } = require('node:path');
@@ -1211,7 +1171,7 @@ The `process.emitWarning()` method can be used to emit custom or application
specific process warnings. These can be listened for by adding a handler to the
[`'warning'`][process_warning] event.
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning with a code and additional detail.
@@ -1222,9 +1182,7 @@ emitWarning('Something happened!', {
// Emits:
// (node:56338) [MY_WARNING] Warning: Something happened!
// This is some additional information
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning with a code and additional detail.
@@ -1241,7 +1199,7 @@ In this example, an `Error` object is generated internally by
`process.emitWarning()` and passed through to the
[`'warning'`][process_warning] handler.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('warning', (warning) => {
@@ -1251,9 +1209,7 @@ process.on('warning', (warning) => {
console.warn(warning.stack); // Stack trace
console.warn(warning.detail); // 'This is some additional information'
});
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('warning', (warning) => {
@@ -1283,15 +1239,13 @@ The `process.emitWarning()` method can be used to emit custom or application
specific process warnings. These can be listened for by adding a handler to the
[`'warning'`][process_warning] event.
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning using a string.
emitWarning('Something happened!');
// Emits: (node: 56338) Warning: Something happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning using a string.
@@ -1299,15 +1253,13 @@ emitWarning('Something happened!');
// Emits: (node: 56338) Warning: Something happened!
```
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning using a string and a type.
emitWarning('Something Happened!', 'CustomWarning');
// Emits: (node:56338) CustomWarning: Something Happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning using a string and a type.
@@ -1315,14 +1267,12 @@ emitWarning('Something Happened!', 'CustomWarning');
// Emits: (node:56338) CustomWarning: Something Happened!
```
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
emitWarning('Something happened!', 'CustomWarning', 'WARN001');
// Emits: (node:56338) [WARN001] CustomWarning: Something happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
process.emitWarning('Something happened!', 'CustomWarning', 'WARN001');
@@ -1333,7 +1283,7 @@ In each of the previous examples, an `Error` object is generated internally by
`process.emitWarning()` and passed through to the [`'warning'`][process_warning]
handler.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('warning', (warning) => {
@@ -1342,9 +1292,7 @@ process.on('warning', (warning) => {
console.warn(warning.code);
console.warn(warning.stack);
});
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('warning', (warning) => {
@@ -1359,7 +1307,7 @@ If `warning` is passed as an `Error` object, it will be passed through to the
`'warning'` event handler unmodified (and the optional `type`,
`code` and `ctor` arguments will be ignored):
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning using an Error object.
@@ -1370,9 +1318,7 @@ myWarning.code = 'WARN001';
emitWarning(myWarning);
// Emits: (node:56338) [WARN001] CustomWarning: Something happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning using an Error object.
@@ -1406,7 +1352,7 @@ The following additional handling is implemented if the warning `type` is
As a best practice, warnings should be emitted only once per process. To do
so, place the `emitWarning()` behind a boolean.
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
function emitMyWarning() {
@@ -1419,9 +1365,7 @@ emitMyWarning();
// Emits: (node: 56339) Warning: Only warn once!
emitMyWarning();
// Emits nothing
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
function emitMyWarning() {
@@ -1473,14 +1417,12 @@ $ node -e 'process.env.foo = "bar"' && echo $foo
While the following will:
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.foo = 'bar';
console.log(env.foo);
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.foo = 'bar';
@@ -1491,7 +1433,7 @@ Assigning a property on `process.env` will implicitly convert the value
to a string. **This behavior is deprecated.** Future versions of Node.js may
throw an error when the value is not a string, number, or boolean.
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.test = null;
@@ -1500,9 +1442,7 @@ console.log(env.test);
env.test = undefined;
console.log(env.test);
// => 'undefined'
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.test = null;
@@ -1515,16 +1455,14 @@ console.log(env.test);
Use `delete` to delete a property from `process.env`.
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.TEST = 1;
delete env.TEST;
console.log(env.TEST);
// => undefined
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.TEST = 1;
@@ -1535,15 +1473,13 @@ console.log(env.TEST);
On Windows operating systems, environment variables are case-insensitive.
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.TEST = 1;
console.log(env.test);
// => 1
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.TEST = 1;
@@ -1617,13 +1553,11 @@ called.
To exit with a 'failure' code:
-```mjs
+```mjs|cjs
import { exit } from 'node:process';
exit(1);
-```
-
-```cjs
+--------------
const { exit } = require('node:process');
exit(1);
@@ -1645,7 +1579,7 @@ For instance, the following example illustrates a _misuse_ of the
`process.exit()` method that could lead to data printed to stdout being
truncated and lost:
-```mjs
+```mjs|cjs
import { exit } from 'node:process';
// This is an example of what *not* to do:
@@ -1653,9 +1587,7 @@ if (someConditionNotMet()) {
printUsageToStdout();
exit(1);
}
-```
-
-```cjs
+--------------
const { exit } = require('node:process');
// This is an example of what *not* to do:
@@ -1674,7 +1606,7 @@ Rather than calling `process.exit()` directly, the code _should_ set the
`process.exitCode` and allow the process to exit naturally by avoiding
scheduling any additional work for the event loop:
-```mjs
+```mjs|cjs
import process from 'node:process';
// How to properly set the exit code while letting
@@ -1683,9 +1615,7 @@ if (someConditionNotMet()) {
printUsageToStdout();
process.exitCode = 1;
}
-```
-
-```cjs
+--------------
const process = require('node:process');
// How to properly set the exit code while letting
@@ -1732,7 +1662,7 @@ The `process.getActiveResourcesInfo()` method returns an array of strings
containing the types of the active resources that are currently keeping the
event loop alive.
-```mjs
+```mjs|cjs
import { getActiveResourcesInfo } from 'node:process';
import { setTimeout } from 'node:timers';
@@ -1742,9 +1672,7 @@ console.log('After:', getActiveResourcesInfo());
// Prints:
// Before: [ 'CloseReq', 'TTYWrap', 'TTYWrap', 'TTYWrap' ]
// After: [ 'CloseReq', 'TTYWrap', 'TTYWrap', 'TTYWrap', 'Timeout' ]
-```
-
-```cjs
+--------------
const { getActiveResourcesInfo } = require('node:process');
const { setTimeout } = require('node:timers');
@@ -1763,15 +1691,13 @@ console.log('After:', getActiveResourcesInfo());
The `process.getegid()` method returns the numerical effective group identity
of the Node.js process. (See getegid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getegid) {
console.log(`Current gid: ${process.getegid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getegid) {
@@ -1791,15 +1717,13 @@ Android).
The `process.geteuid()` method returns the numerical effective user identity of
the process. (See geteuid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.geteuid) {
console.log(`Current uid: ${process.geteuid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.geteuid) {
@@ -1819,15 +1743,13 @@ Android).
The `process.getgid()` method returns the numerical group identity of the
process. (See getgid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgid) {
console.log(`Current gid: ${process.getgid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgid) {
@@ -1848,15 +1770,13 @@ The `process.getgroups()` method returns an array with the supplementary group
IDs. POSIX leaves it unspecified if the effective group ID is included but
Node.js ensures it always is.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgroups) {
console.log(process.getgroups()); // [ 16, 21, 297 ]
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgroups) {
@@ -1876,15 +1796,13 @@ Android).
The `process.getuid()` method returns the numeric user identity of the process.
(See getuid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getuid) {
console.log(`Current uid: ${process.getuid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getuid) {
@@ -1934,7 +1852,7 @@ These times are relative to an arbitrary time in the
past, and not related to the time of day and therefore not subject to clock
drift. The primary use is for measuring performance between intervals:
-```mjs
+```mjs|cjs
import { hrtime } from 'node:process';
const NS_PER_SEC = 1e9;
@@ -1948,9 +1866,7 @@ setTimeout(() => {
console.log(`Benchmark took ${diff[0] * NS_PER_SEC + diff[1]} nanoseconds`);
// Benchmark took 1000000552 nanoseconds
}, 1000);
-```
-
-```cjs
+--------------
const { hrtime } = require('node:process');
const NS_PER_SEC = 1e9;
@@ -1979,7 +1895,7 @@ Unlike [`process.hrtime()`][], it does not support an additional `time`
argument since the difference can just be computed directly
by subtraction of the two `bigint`s.
-```mjs
+```mjs|cjs
import { hrtime } from 'node:process';
const start = hrtime.bigint();
@@ -1992,9 +1908,7 @@ setTimeout(() => {
console.log(`Benchmark took ${end - start} nanoseconds`);
// Benchmark took 1154389282 nanoseconds
}, 1000);
-```
-
-```cjs
+--------------
const { hrtime } = require('node:process');
const start = hrtime.bigint();
@@ -2023,7 +1937,7 @@ access or the `CAP_SETGID` capability.
Use care when dropping privileges:
-```mjs
+```mjs|cjs
import { getgroups, initgroups, setgid } from 'node:process';
console.log(getgroups()); // [ 0 ]
@@ -2031,9 +1945,7 @@ initgroups('nodeuser', 1000); // switch user
console.log(getgroups()); // [ 27, 30, 46, 1000, 0 ]
setgid(1000); // drop root gid
console.log(getgroups()); // [ 27, 30, 46, 1000 ]
-```
-
-```cjs
+--------------
const { getgroups, initgroups, setgid } = require('node:process');
console.log(getgroups()); // [ 0 ]
@@ -2070,7 +1982,7 @@ Even though the name of this function is `process.kill()`, it is really just a
signal sender, like the `kill` system call. The signal sent may do something
other than kill the target process.
-```mjs
+```mjs|cjs
import process, { kill } from 'node:process';
process.on('SIGHUP', () => {
@@ -2083,9 +1995,7 @@ setTimeout(() => {
}, 100);
kill(process.pid, 'SIGHUP');
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('SIGHUP', () => {
@@ -2138,7 +2048,7 @@ is no entry script.
Returns an object describing the memory usage of the Node.js process measured in
bytes.
-```mjs
+```mjs|cjs
import { memoryUsage } from 'node:process';
console.log(memoryUsage());
@@ -2150,9 +2060,7 @@ console.log(memoryUsage());
// external: 49879,
// arrayBuffers: 9386
// }
-```
-
-```cjs
+--------------
const { memoryUsage } = require('node:process');
console.log(memoryUsage());
@@ -2201,14 +2109,12 @@ process, including all C++ and JavaScript objects and code.
This is the same value as the `rss` property provided by `process.memoryUsage()`
but `process.memoryUsage.rss()` is faster.
-```mjs
+```mjs|cjs
import { memoryUsage } from 'node:process';
console.log(memoryUsage.rss());
// 35655680
-```
-
-```cjs
+--------------
const { rss } = require('node:process');
console.log(memoryUsage.rss());
@@ -2228,7 +2134,7 @@ completion and before the event loop is allowed to continue. It's possible to
create an infinite loop if one were to recursively call `process.nextTick()`.
See the [Event Loop][] guide for more background.
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
console.log('start');
@@ -2240,9 +2146,7 @@ console.log('scheduled');
// start
// scheduled
// nextTick callback
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
console.log('start');
@@ -2260,7 +2164,7 @@ This is important when developing APIs in order to give users the opportunity
to assign event handlers _after_ an object has been constructed but before any
I/O has occurred:
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
function MyThing(options) {
@@ -2275,9 +2179,7 @@ const thing = new MyThing();
thing.getReadyForStuff();
// thing.startDoingStuff() gets called now, not before.
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
function MyThing(options) {
@@ -2325,7 +2227,7 @@ It is not clear whether `foo()` or `bar()` will be called first.
The following approach is much better:
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
function definitelyAsync(arg, cb) {
@@ -2336,9 +2238,7 @@ function definitelyAsync(arg, cb) {
fs.stat('file', cb);
}
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
function definitelyAsync(arg, cb) {
@@ -2359,7 +2259,7 @@ execute the then, catch, and finally handlers of resolved promises. Within
Node.js, every time the "next tick queue" is drained, the microtask queue
is drained immediately after.
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
Promise.resolve().then(() => console.log(2));
@@ -2369,9 +2269,7 @@ nextTick(() => console.log(1));
// 1
// 2
// 3
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
Promise.resolve().then(() => console.log(2));
@@ -2449,13 +2347,11 @@ flag's behavior.
The `process.pid` property returns the PID of the process.
-```mjs
+```mjs|cjs
import { pid } from 'node:process';
console.log(`This process is pid ${pid}`);
-```
-
-```cjs
+--------------
const { pid } = require('node:process');
console.log(`This process is pid ${pid}`);
@@ -2480,13 +2376,11 @@ Currently possible values are:
* `'sunos'`
* `'win32'`
-```mjs
+```mjs|cjs
import { platform } from 'node:process';
console.log(`This platform is ${platform}`);
-```
-
-```cjs
+--------------
const { platform } = require('node:process');
console.log(`This platform is ${platform}`);
@@ -2505,13 +2399,11 @@ Android operating system. However, Android support in Node.js
The `process.ppid` property returns the PID of the parent of the
current process.
-```mjs
+```mjs|cjs
import { ppid } from 'node:process';
console.log(`The parent process is pid ${ppid}`);
-```
-
-```cjs
+--------------
const { ppid } = require('node:process');
console.log(`The parent process is pid ${ppid}`);
@@ -2583,13 +2475,11 @@ Write reports in a compact format, single-line JSON, more easily consumable
by log processing systems than the default multi-line format designed for
human consumption.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Reports are compact? ${report.compact}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Reports are compact? ${report.compact}`);
@@ -2605,13 +2495,11 @@ Directory where the report is written. The default value is the empty string,
indicating that reports are written to the current working directory of the
Node.js process.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report directory is ${report.directory}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report directory is ${report.directory}`);
@@ -2630,13 +2518,11 @@ value is the empty string.
If the value of `process.report.filename` is set to `'stdout'` or `'stderr'`,
the report is written to the stdout or stderr of the process respectively.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report filename is ${report.filename}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report filename is ${report.filename}`);
@@ -2653,7 +2539,7 @@ Returns a JavaScript Object representation of a diagnostic report for the
running process. The report's JavaScript stack trace is taken from `err`, if
present.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
const data = report.getReport();
@@ -2662,9 +2548,7 @@ console.log(data.header.nodejsVersion);
// Similar to process.report.writeReport()
import fs from 'node:fs';
fs.writeFileSync('my-report.log', util.inspect(data), 'utf8');
-```
-
-```cjs
+--------------
const { report } = require('node:process');
const data = report.getReport();
@@ -2686,13 +2570,11 @@ Additional documentation is available in the [report documentation][].
If `true`, a diagnostic report is generated on fatal errors, such as out of
memory errors or failed C++ assertions.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report on fatal error: ${report.reportOnFatalError}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report on fatal error: ${report.reportOnFatalError}`);
@@ -2707,13 +2589,11 @@ console.log(`Report on fatal error: ${report.reportOnFatalError}`);
If `true`, a diagnostic report is generated when the process receives the
signal specified by `process.report.signal`.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report on signal: ${report.reportOnSignal}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report on signal: ${report.reportOnSignal}`);
@@ -2727,13 +2607,11 @@ console.log(`Report on signal: ${report.reportOnSignal}`);
If `true`, a diagnostic report is generated on uncaught exception.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report on exception: ${report.reportOnUncaughtException}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report on exception: ${report.reportOnUncaughtException}`);
@@ -2748,13 +2626,11 @@ console.log(`Report on exception: ${report.reportOnUncaughtException}`);
The signal used to trigger the creation of a diagnostic report. Defaults to
`'SIGUSR2'`.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report signal: ${report.signal}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report signal: ${report.signal}`);
@@ -2780,13 +2656,11 @@ JavaScript stack trace is taken from `err`, if present.
If the value of `filename` is set to `'stdout'` or `'stderr'`, the report is
written to the stdout or stderr of the process respectively.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
report.writeReport();
-```
-
-```cjs
+--------------
const { report } = require('node:process');
report.writeReport();
@@ -2841,7 +2715,7 @@ Additional documentation is available in the [report documentation][].
process becoming runnable or because the current process exceeded its
time slice. This field is not supported on Windows.
-```mjs
+```mjs|cjs
import { resourceUsage } from 'node:process';
console.log(resourceUsage());
@@ -2866,9 +2740,7 @@ console.log(resourceUsage());
involuntaryContextSwitches: 1
}
*/
-```
-
-```cjs
+--------------
const { resourceUsage } = require('node:process');
console.log(resourceUsage());
@@ -2930,7 +2802,7 @@ The `process.setegid()` method sets the effective group identity of the process.
name string. If a group name is specified, this method blocks while resolving
the associated a numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getegid && process.setegid) {
@@ -2942,9 +2814,7 @@ if (process.getegid && process.setegid) {
console.log(`Failed to set gid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getegid && process.setegid) {
@@ -2973,7 +2843,7 @@ The `process.seteuid()` method sets the effective user identity of the process.
string. If a username is specified, the method blocks while resolving the
associated numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.geteuid && process.seteuid) {
@@ -2985,9 +2855,7 @@ if (process.geteuid && process.seteuid) {
console.log(`Failed to set uid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.geteuid && process.seteuid) {
@@ -3016,7 +2884,7 @@ setgid(2).) The `id` can be passed as either a numeric ID or a group name
string. If a group name is specified, this method blocks while resolving the
associated numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgid && process.setgid) {
@@ -3028,9 +2896,7 @@ if (process.getgid && process.setgid) {
console.log(`Failed to set gid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgid && process.setgid) {
@@ -3060,7 +2926,7 @@ process to have `root` or the `CAP_SETGID` capability.
The `groups` array can contain numeric group IDs, group names, or both.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgroups && process.setgroups) {
@@ -3071,9 +2937,7 @@ if (process.getgroups && process.setgroups) {
console.log(`Failed to set groups: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgroups && process.setgroups) {
@@ -3101,7 +2965,7 @@ setuid(2).) The `id` can be passed as either a numeric ID or a username string.
If a username is specified, the method blocks while resolving the associated
numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getuid && process.setuid) {
@@ -3113,9 +2977,7 @@ if (process.getuid && process.setuid) {
console.log(`Failed to set uid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getuid && process.setuid) {
@@ -3236,13 +3098,11 @@ a [Writable][] stream.
For example, to copy `process.stdin` to `process.stdout`:
-```mjs
+```mjs|cjs
import { stdin, stdout } from 'node:process';
stdin.pipe(stdout);
-```
-
-```cjs
+--------------
const { stdin, stdout } = require('node:process');
stdin.pipe(stdout);
@@ -3393,7 +3253,7 @@ processes inherit the mask from the parent process.
`process.umask(mask)` sets the Node.js process's file mode creation mask. Child
processes inherit the mask from the parent process. Returns the previous mask.
-```mjs
+```mjs|cjs
import { umask } from 'node:process';
const newmask = 0o022;
@@ -3401,9 +3261,7 @@ const oldmask = umask(newmask);
console.log(
`Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`
);
-```
-
-```cjs
+--------------
const { umask } = require('node:process');
const newmask = 0o022;
@@ -3435,14 +3293,12 @@ seconds.
The `process.version` property contains the Node.js version string.
-```mjs
+```mjs|cjs
import { version } from 'node:process';
console.log(`Version: ${version}`);
// Version: v14.8.0
-```
-
-```cjs
+--------------
const { version } = require('node:process');
console.log(`Version: ${version}`);
@@ -3463,13 +3319,11 @@ Node.js and its dependencies. `process.versions.modules` indicates the current
ABI version, which is increased whenever a C++ API changes. Node.js will refuse
to load modules that were compiled against a different module ABI version.
-```mjs
+```mjs|cjs
import { versions } from 'node:process';
console.log(versions);
-```
-
-```cjs
+--------------
const { versions } = require('node:process');
console.log(versions);
diff --git a/content/api/v16/punycode.en.md b/content/api/v16/punycode.en.md
index 9d14574e4c..6123f579e6 100644
--- a/content/api/v16/punycode.en.md
+++ b/content/api/v16/punycode.en.md
@@ -15,7 +15,7 @@ Deprecated
-
#include
napi_value result;
@@ -1646,9 +1642,7 @@ static napi_value MyNapi(napi_env env, napi_callback_info info) {
...
DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
...
-```
-
-```js
+--------------
const native = require('napi_addon.node');
const data = native.myNapi();
util.types.isExternal(data); // returns true
diff --git a/content/api/v16/v8.en.md b/content/api/v16/v8.en.md
index c949db60ef..64a8696ad5 100644
--- a/content/api/v16/v8.en.md
+++ b/content/api/v16/v8.en.md
@@ -7,7 +7,7 @@ version: 'v16'
-`options.onPropagate` is experimental.
+Experimental
-* `options` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- * `onPropagate` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) Optional callback invoked before a store is
- propagated to a new async resource. Returning `true` allows propagation,
- returning `false` avoids it. Default is to propagate always.
+* `fn` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) The function to bind to the current execution context.
+* Returns: [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) A new function that calls `fn` within the captured
+ execution context.
-Creates a new instance of `AsyncLocalStorage`. Store is only provided within a
-`run()` call or after an `enterWith()` call.
+Binds the given function to the current execution context.
+
+#### Static method: `AsyncLocalStorage.snapshot()`
+
+
+
+Experimental
+
+
+
+* Returns: [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) A new function with the signature
+ `(fn: (...args) : R, ...args) : R`.
+
+Captures the current execution context and returns a function that accepts a
+function as an argument. Whenever the returned function is called, it
+calls the function passed to it within the captured context.
-The `onPropagate` is called during creation of an async resource. Throwing at
-this time will print the stack trace and exit. See
-[`async_hooks` Error handling][] for details.
+```js
+const asyncLocalStorage = new AsyncLocalStorage();
+const runInAsyncScope = asyncLocalStorage.run(123, () => asyncLocalStorage.snapshot());
+const result = asyncLocalStorage.run(321, () => runInAsyncScope(() => asyncLocalStorage.getStore()));
+console.log(result); // returns 123
+```
+
+AsyncLocalStorage.snapshot() can replace the use of AsyncResource for simple
+async context tracking purposes, for example:
+
+```js
+class Foo {
+ #runInAsyncScope = AsyncLocalStorage.snapshot();
+
+ get() { return this.#runInAsyncScope(() => asyncLocalStorage.getStore()); }
+}
-Creating an async resource within the `onPropagate` callback will result in
-a recursive call to `onPropagate`.
+const foo = asyncLocalStorage.run(123, () => new Foo());
+console.log(asyncLocalStorage.run(321, () => foo.get())); // returns 123
+```
####
console.log(Buffer.from('fhqwhgads', 'utf16le'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('hello world', 'utf8');
@@ -194,7 +190,7 @@ The following legacy character encodings are also supported:
of UTF-16 that did not support characters that had code points larger than
U+FFFF. In Node.js, these code points are always supported.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
Buffer.from('1ag123', 'hex');
@@ -206,9 +202,7 @@ Buffer.from('1a7', 'hex');
Buffer.from('1634', 'hex');
// Prints , all data represented.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
Buffer.from('1ag123', 'hex');
@@ -255,7 +249,7 @@ There are two ways to create new [`TypedArray`][] instances from a `Buffer`:
contents, interpreted as an array of integers, and not as a byte sequence
of the target type.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
@@ -264,9 +258,7 @@ const uint32array = new Uint32Array(buf);
console.log(uint32array);
// Prints: Uint32Array(4) [ 1, 2, 3, 4 ]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -280,7 +272,7 @@ console.log(uint32array);
* Passing the `Buffer`s underlying [`ArrayBuffer`][] will create a
[`TypedArray`][] that shares its memory with the `Buffer`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('hello', 'utf16le');
@@ -292,9 +284,7 @@ const uint16array = new Uint16Array(
console.log(uint16array);
// Prints: Uint16Array(5) [ 104, 101, 108, 108, 111 ]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('hello', 'utf16le');
@@ -313,7 +303,7 @@ 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.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arr = new Uint16Array(2);
@@ -338,9 +328,7 @@ console.log(buf1);
// Prints:
console.log(buf2);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(2);
@@ -371,7 +359,7 @@ 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
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arr = new Uint16Array(20);
@@ -379,9 +367,7 @@ const buf = Buffer.from(arr.buffer, 0, 16);
console.log(buf.length);
// Prints: 16
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(20);
@@ -410,7 +396,7 @@ function:
`Buffer` instances can be iterated over using `for..of` syntax:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3]);
@@ -422,9 +408,7 @@ for (const b of buf) {
// 1
// 2
// 3
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3]);
@@ -530,7 +514,7 @@ destinations without transferring or immediately copying the data. The data
contained by the `Blob` is copied only when the `arrayBuffer()` or `text()`
methods are called.
-```mjs
+```mjs|cjs
import { Blob, Buffer } from 'node:buffer';
import { setTimeout as delay } from 'node:timers/promises';
@@ -555,9 +539,7 @@ mc2.port2.postMessage(blob);
// The Blob is still usable after posting.
blob.text().then(console.log);
-```
-
-```cjs
+--------------
const { Blob, Buffer } = require('node:buffer');
const { setTimeout: delay } = require('node:timers/promises');
@@ -602,16 +584,14 @@ It can be constructed in a variety of ways.
Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the
`Buffer` will be zero-filled.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(5);
@@ -627,16 +607,14 @@ is thrown.
If `fill` is specified, the allocated `Buffer` will be initialized by calling
[`buf.fill(fill)`][`buf.fill()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5, 'a');
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(5, 'a');
@@ -648,16 +626,14 @@ console.log(buf);
If both `fill` and `encoding` are specified, the allocated `Buffer` will be
initialized by calling [`buf.fill(fill, encoding)`][`buf.fill()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
@@ -688,7 +664,7 @@ initialized_. The contents of the newly created `Buffer` are unknown and
_may contain sensitive data_. Use [`Buffer.alloc()`][] instead to initialize
`Buffer` instances with zeroes.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(10);
@@ -700,9 +676,7 @@ buf.fill(0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(10);
@@ -760,7 +734,7 @@ memory from a pool for an indeterminate amount of time, it may be appropriate
to create an un-pooled `Buffer` instance using `Buffer.allocUnsafeSlow()` and
then copying out the relevant bits.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Need to keep around a few small chunks of memory.
@@ -778,9 +752,7 @@ socket.on('readable', () => {
store.push(sb);
}
});
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Need to keep around a few small chunks of memory.
@@ -821,7 +793,7 @@ For strings that contain non-base64/hex-encoded data (e.g. whitespace), the
return value might be greater than the length of a `Buffer` created from the
string.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const str = '\u00bd + \u00bc = \u00be';
@@ -829,9 +801,7 @@ const str = '\u00bd + \u00bc = \u00be';
console.log(`${str}: ${str.length} characters, ` +
`${Buffer.byteLength(str, 'utf8')} bytes`);
// Prints: ½ + ¼ = ¾: 9 characters, 12 bytes
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const str = '\u00bd + \u00bc = \u00be';
@@ -858,7 +828,7 @@ Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of
`Buffer` instances. This is equivalent to calling
[`buf1.compare(buf2)`][`buf.compare()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('1234');
@@ -868,9 +838,7 @@ const arr = [buf1, buf2];
console.log(arr.sort(Buffer.compare));
// Prints: [ , ]
// (This result is equal to: [buf2, buf1].)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('1234');
@@ -905,7 +873,7 @@ If `totalLength` is provided, it is coerced to an unsigned integer. If the
combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is
truncated to `totalLength`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a single `Buffer` from a list of three `Buffer` instances.
@@ -924,9 +892,7 @@ console.log(bufA);
// Prints:
console.log(bufA.length);
// Prints: 42
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a single `Buffer` from a list of three `Buffer` instances.
@@ -950,6 +916,26 @@ console.log(bufA.length);
`Buffer.concat()` may also use the internal `Buffer` pool like
[`Buffer.allocUnsafe()`][] does.
+#### Static method: `Buffer.copyBytesFrom(view[, offset[, length]])`
+
+
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(2);
@@ -1040,7 +1022,7 @@ console.log(buf);
The optional `byteOffset` and `length` arguments specify a memory range within
the `arrayBuffer` that will be shared by the `Buffer`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const ab = new ArrayBuffer(10);
@@ -1048,9 +1030,7 @@ const buf = Buffer.from(ab, 0, 2);
console.log(buf.length);
// Prints: 2
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const ab = new ArrayBuffer(10);
@@ -1069,7 +1049,7 @@ of memory that extends beyond the bounds of a `TypedArray` view. A new
`Buffer` created using the `buffer` property of a `TypedArray` may extend
beyond the range of the `TypedArray`:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 elements
@@ -1079,9 +1059,7 @@ console.log(arrA.buffer === arrB.buffer); // true
const buf = Buffer.from(arrB.buffer);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 elements
@@ -1102,7 +1080,7 @@ console.log(buf);
Copies the passed `buffer` data onto a new `Buffer` instance.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('buffer');
@@ -1114,9 +1092,7 @@ console.log(buf1.toString());
// Prints: auffer
console.log(buf2.toString());
// Prints: buffer
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('buffer');
@@ -1144,14 +1120,12 @@ appropriate for `Buffer.from()` variants.
For objects whose `valueOf()` function returns a value not strictly equal to
`object`, returns `Buffer.from(object.valueOf(), offsetOrEncoding, length)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from(new String('this is a test'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from(new String('this is a test'));
@@ -1161,7 +1135,7 @@ const buf = Buffer.from(new String('this is a test'));
For objects that support `Symbol.toPrimitive`, returns
`Buffer.from(object[Symbol.toPrimitive]('string'), offsetOrEncoding)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
class Foo {
@@ -1172,9 +1146,7 @@ class Foo {
const buf = Buffer.from(new Foo(), 'utf8');
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
class Foo {
@@ -1200,7 +1172,7 @@ is not of another type appropriate for `Buffer.from()` variants.
Creates a new `Buffer` containing `string`. The `encoding` parameter identifies
the character encoding to be used when converting `string` into bytes.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('this is a tést');
@@ -1212,9 +1184,7 @@ console.log(buf2.toString());
// Prints: this is a tést
console.log(buf1.toString('latin1'));
// Prints: this is a tést
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('this is a tést');
@@ -1240,7 +1210,7 @@ appropriate for `Buffer.from()` variants.
Returns `true` if `obj` is a `Buffer`, `false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
Buffer.isBuffer(Buffer.alloc(10)); // true
@@ -1248,9 +1218,7 @@ Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
Buffer.isBuffer(Buffer.alloc(10)); // true
@@ -1270,7 +1238,7 @@ Buffer.isBuffer(new Uint8Array(1024)); // false
Returns `true` if `encoding` is the name of a supported character encoding,
or `false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
console.log(Buffer.isEncoding('utf8'));
@@ -1284,9 +1252,7 @@ console.log(Buffer.isEncoding('utf/8'));
console.log(Buffer.isEncoding(''));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
console.log(Buffer.isEncoding('utf8'));
@@ -1325,7 +1291,7 @@ access is the same as `Uint8Array`. In other words, `buf[index]` returns
`buf[index] = value` does not modify the buffer if `index` is negative or
`>= buf.length`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Copy an ASCII string into a `Buffer` one byte at a time.
@@ -1341,9 +1307,7 @@ for (let i = 0; i < str.length; i++) {
console.log(buf.toString('utf8'));
// Prints: Node.js
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Copy an ASCII string into a `Buffer` one byte at a time.
@@ -1369,7 +1333,7 @@ console.log(buf.toString('utf8'));
This `ArrayBuffer` is not guaranteed to correspond exactly to the original
`Buffer`. See the notes on `buf.byteOffset` for details.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arrayBuffer = new ArrayBuffer(16);
@@ -1377,9 +1341,7 @@ const buffer = Buffer.from(arrayBuffer);
console.log(buffer.buffer === arrayBuffer);
// Prints: true
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arrayBuffer = new ArrayBuffer(16);
@@ -1404,7 +1366,7 @@ to the `Buffer` object itself.
A common issue when creating a `TypedArray` object that shares its memory with
a `Buffer` is that in this case one needs to specify the `byteOffset` correctly:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a buffer smaller than `Buffer.poolSize`.
@@ -1414,9 +1376,7 @@ const nodeBuffer = Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
// to refer only to the part of `nodeBuffer.buffer` that contains the memory
// for `nodeBuffer`.
new Int8Array(nodeBuffer.buffer, nodeBuffer.byteOffset, nodeBuffer.length);
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a buffer smaller than `Buffer.poolSize`.
@@ -1452,7 +1412,7 @@ Comparison is based on the actual sequence of bytes in each `Buffer`.
* `1` is returned if `target` should come _before_ `buf` when sorted.
* `-1` is returned if `target` should come _after_ `buf` when sorted.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
@@ -1472,9 +1432,7 @@ console.log(buf2.compare(buf3));
console.log([buf1, buf2, buf3].sort(Buffer.compare));
// Prints: [ , , ]
// (This result is equal to: [buf1, buf3, buf2].)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('ABC');
@@ -1500,7 +1458,7 @@ The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`
arguments can be used to limit the comparison to specific ranges within `target`
and `buf` respectively.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
@@ -1512,9 +1470,7 @@ console.log(buf1.compare(buf2, 0, 6, 4));
// Prints: -1
console.log(buf1.compare(buf2, 5, 6, 5));
// Prints: 1
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
@@ -1551,7 +1507,7 @@ memory region overlaps with `buf`.
for all TypedArrays, including Node.js `Buffer`s, although it takes
different function arguments.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create two `Buffer` instances.
@@ -1570,9 +1526,7 @@ buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create two `Buffer` instances.
@@ -1593,7 +1547,7 @@ console.log(buf2.toString('ascii', 0, 25));
// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
```
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` and copy data from one region to an overlapping region
@@ -1610,9 +1564,7 @@ buf.copy(buf, 0, 4, 10);
console.log(buf.toString());
// Prints: efghijghijklmnopqrstuvwxyz
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` and copy data from one region to an overlapping region
@@ -1640,7 +1592,7 @@ console.log(buf.toString());
Creates and returns an [iterator][] of `[index, byte]` pairs from the contents
of `buf`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Log the entire contents of a `Buffer`.
@@ -1657,9 +1609,7 @@ for (const pair of buf.entries()) {
// [3, 102]
// [4, 101]
// [5, 114]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Log the entire contents of a `Buffer`.
@@ -1690,7 +1640,7 @@ Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,
`false` otherwise. Equivalent to
[`buf.compare(otherBuffer) === 0`][`buf.compare()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
@@ -1701,9 +1651,7 @@ console.log(buf1.equals(buf2));
// Prints: true
console.log(buf1.equals(buf3));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('ABC');
@@ -1733,7 +1681,7 @@ console.log(buf1.equals(buf3));
Fills `buf` with the specified `value`. If the `offset` and `end` are not given,
the entire `buf` will be filled:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with the ASCII character 'h'.
@@ -1748,9 +1696,7 @@ const c = Buffer.allocUnsafe(5).fill('');
console.log(c.fill(''));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Fill a `Buffer` with the ASCII character 'h'.
@@ -1774,16 +1720,14 @@ filled with `value & 255`.
If the final write of a `fill()` operation falls on a multi-byte character,
then only the bytes of that character that fit into `buf` are written:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with character that takes up two bytes in UTF-8.
console.log(Buffer.allocUnsafe(5).fill('\u0222'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Fill a `Buffer` with character that takes up two bytes in UTF-8.
@@ -1795,7 +1739,7 @@ console.log(Buffer.allocUnsafe(5).fill('\u0222'));
If `value` contains invalid characters, it is truncated; if no valid
fill data remains, an exception is thrown:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(5);
@@ -1806,9 +1750,7 @@ console.log(buf.fill('aazz', 'hex'));
// Prints:
console.log(buf.fill('zz', 'hex'));
// Throws an exception.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(5);
@@ -1834,7 +1776,7 @@ console.log(buf.fill('zz', 'hex'));
Equivalent to [`buf.indexOf() !== -1`][`buf.indexOf()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
@@ -1853,9 +1795,7 @@ console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: true
console.log(buf.includes('this', 4));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this is a buffer');
@@ -1898,7 +1838,7 @@ If `value` is:
* a number, `value` will be interpreted as an unsigned 8-bit integer
value between `0` and `255`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
@@ -1922,9 +1862,7 @@ console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
// Prints: 4
console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
// Prints: 6
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this is a buffer');
@@ -1958,7 +1896,7 @@ If `byteOffset` is not a number, it will be coerced to a number. If the result
of coercion is `NaN` or `0`, then the entire buffer will be searched. This
behavior matches [`String.prototype.indexOf()`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const b = Buffer.from('abcdef');
@@ -1974,9 +1912,7 @@ console.log(b.indexOf('b', undefined));
console.log(b.indexOf('b', {}));
console.log(b.indexOf('b', null));
console.log(b.indexOf('b', []));
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const b = Buffer.from('abcdef');
@@ -2006,7 +1942,7 @@ than `buf.length`, `byteOffset` will be returned. If `value` is empty and
Creates and returns an [iterator][] of `buf` keys (indices).
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -2021,9 +1957,7 @@ for (const key of buf.keys()) {
// 3
// 4
// 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -2057,7 +1991,7 @@ for (const key of buf.keys()) {
Identical to [`buf.indexOf()`][], except the last occurrence of `value` is found
rather than the first occurrence.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this buffer is a buffer');
@@ -2083,9 +2017,7 @@ console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// Prints: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// Prints: 4
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this buffer is a buffer');
@@ -2121,7 +2053,7 @@ If `byteOffset` is not a number, it will be coerced to a number. Any arguments
that coerce to `NaN`, like `{}` or `undefined`, will search the whole buffer.
This behavior matches [`String.prototype.lastIndexOf()`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const b = Buffer.from('abcdef');
@@ -2140,9 +2072,7 @@ console.log(b.lastIndexOf('b', {}));
// Prints: -1, equivalent to passing 0.
console.log(b.lastIndexOf('b', null));
console.log(b.lastIndexOf('b', []));
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const b = Buffer.from('abcdef');
@@ -2173,7 +2103,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
Returns the number of bytes in `buf`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` and write a shorter string to it using UTF-8.
@@ -2187,9 +2117,7 @@ buf.write('some string', 0, 'utf8');
console.log(buf.length);
// Prints: 1234
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` and write a shorter string to it using UTF-8.
@@ -2257,16 +2185,14 @@ Reads an unsigned, big-endian 64-bit integer from `buf` at the specified
This function is also available under the `readBigUint64BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64BE(0));
// Prints: 4294967295n
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
@@ -2288,16 +2214,14 @@ Reads an unsigned, little-endian 64-bit integer from `buf` at the specified
This function is also available under the `readBigUint64LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64LE(0));
// Prints: 18446744069414584320n
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
@@ -2316,16 +2240,14 @@ console.log(buf.readBigUInt64LE(0));
Reads a 64-bit, big-endian double from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleBE(0));
// Prints: 8.20788039913184e-304
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2344,7 +2266,7 @@ console.log(buf.readDoubleBE(0));
Reads a 64-bit, little-endian double from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2353,9 +2275,7 @@ console.log(buf.readDoubleLE(0));
// Prints: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2376,16 +2296,14 @@ console.log(buf.readDoubleLE(1));
Reads a 32-bit, big-endian float from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatBE(0));
// Prints: 2.387939260590663e-38
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2404,7 +2322,7 @@ console.log(buf.readFloatBE(0));
Reads a 32-bit, little-endian float from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2413,9 +2331,7 @@ console.log(buf.readFloatLE(0));
// Prints: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2438,7 +2354,7 @@ Reads a signed 8-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([-1, 5]);
@@ -2449,9 +2365,7 @@ console.log(buf.readInt8(1));
// Prints: 5
console.log(buf.readInt8(2));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([-1, 5]);
@@ -2476,16 +2390,14 @@ Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16BE(0));
// Prints: 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 5]);
@@ -2507,7 +2419,7 @@ Reads a signed, little-endian 16-bit integer from `buf` at the specified
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
@@ -2516,9 +2428,7 @@ console.log(buf.readInt16LE(0));
// Prints: 1280
console.log(buf.readInt16LE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 5]);
@@ -2541,16 +2451,14 @@ Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32BE(0));
// Prints: 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2572,7 +2480,7 @@ Reads a signed, little-endian 32-bit integer from `buf` at the specified
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2581,9 +2489,7 @@ console.log(buf.readInt32LE(0));
// Prints: 83886080
console.log(buf.readInt32LE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2608,7 +2514,7 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as a big-endian, two's complement signed value
supporting up to 48 bits of accuracy.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2619,9 +2525,7 @@ console.log(buf.readIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
console.log(buf.readIntBE(1, 0).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2648,16 +2552,14 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as a little-endian, two's complement signed value
supporting up to 48 bits of accuracy.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntLE(0, 6).toString(16));
// Prints: -546f87a9cbee
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2678,7 +2580,7 @@ Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
This function is also available under the `readUint8` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, -2]);
@@ -2689,9 +2591,7 @@ console.log(buf.readUInt8(1));
// Prints: 254
console.log(buf.readUInt8(2));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, -2]);
@@ -2717,7 +2617,7 @@ Reads an unsigned, big-endian 16-bit integer from `buf` at the specified
This function is also available under the `readUint16BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2726,9 +2626,7 @@ console.log(buf.readUInt16BE(0).toString(16));
// Prints: 1234
console.log(buf.readUInt16BE(1).toString(16));
// Prints: 3456
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2752,7 +2650,7 @@ Reads an unsigned, little-endian 16-bit integer from `buf` at the specified
This function is also available under the `readUint16LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2763,9 +2661,7 @@ console.log(buf.readUInt16LE(1).toString(16));
// Prints: 5634
console.log(buf.readUInt16LE(2).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2791,16 +2687,14 @@ Reads an unsigned, big-endian 32-bit integer from `buf` at the specified
This function is also available under the `readUint32BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32BE(0).toString(16));
// Prints: 12345678
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2822,7 +2716,7 @@ Reads an unsigned, little-endian 32-bit integer from `buf` at the specified
This function is also available under the `readUint32LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2831,9 +2725,7 @@ console.log(buf.readUInt32LE(0).toString(16));
// Prints: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2860,7 +2752,7 @@ up to 48 bits of accuracy.
This function is also available under the `readUintBE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2869,9 +2761,7 @@ console.log(buf.readUIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2898,16 +2788,14 @@ up to 48 bits of accuracy.
This function is also available under the `readUintLE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntLE(0, 6).toString(16));
// Prints: ab9078563412
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2936,7 +2824,7 @@ This method is inherited from [`TypedArray.prototype.subarray()`][].
Modifying the new `Buffer` slice will modify the memory in the original `Buffer`
because the allocated memory of the two objects overlap.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
@@ -2958,9 +2846,7 @@ buf1[0] = 33;
console.log(buf2.toString('ascii', 0, buf2.length));
// Prints: !bc
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
@@ -2987,7 +2873,7 @@ console.log(buf2.toString('ascii', 0, buf2.length));
Specifying negative indexes causes the slice to be generated relative to the
end of `buf` rather than the beginning.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3003,9 +2889,7 @@ console.log(buf.subarray(-6, -2).toString());
console.log(buf.subarray(-5, -2).toString());
// Prints: uff
// (Equivalent to buf.subarray(1, 4).)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3045,7 +2929,7 @@ This method is not compatible with the `Uint8Array.prototype.slice()`,
which is a superclass of `Buffer`. To copy the slice, use
`Uint8Array.prototype.slice()`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3065,9 +2949,7 @@ console.log(notReallyCopiedBuf.toString());
// Prints: cuffer
console.log(buf.toString());
// Also prints: cuffer (!)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3099,7 +2981,7 @@ Interprets `buf` as an array of unsigned 16-bit integers and swaps the
byte order _in-place_. Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][]
is not a multiple of 2.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3116,9 +2998,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap16();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3140,14 +3020,12 @@ buf2.swap16();
One convenient use of `buf.swap16()` is to perform a fast in-place conversion
between UTF-16 little-endian and UTF-16 big-endian:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
buf.swap16(); // Convert to big-endian UTF-16 text.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
@@ -3164,7 +3042,7 @@ Interprets `buf` as an array of unsigned 32-bit integers and swaps the
byte order _in-place_. Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][]
is not a multiple of 4.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3181,9 +3059,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap32();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3211,7 +3087,7 @@ buf2.swap32();
Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_.
Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][] is not a multiple of 8.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3228,9 +3104,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3261,7 +3135,7 @@ this function when stringifying a `Buffer` instance.
`Buffer.from()` accepts objects in the format returned from this method.
In particular, `Buffer.from(buf.toJSON())` works like `Buffer.from(buf)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
@@ -3278,9 +3152,7 @@ const copy = JSON.parse(json, (key, value) => {
console.log(copy);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
@@ -3318,7 +3190,7 @@ then each invalid byte 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`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.allocUnsafe(26);
@@ -3341,9 +3213,7 @@ console.log(buf2.toString('utf8', 0, 3));
// Prints: té
console.log(buf2.toString(undefined, 0, 3));
// Prints: té
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.allocUnsafe(26);
@@ -3377,7 +3247,7 @@ console.log(buf2.toString(undefined, 0, 3));
Creates and returns an [iterator][] for `buf` values (bytes). This function is
called automatically when a `Buffer` is used in a `for..of` statement.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3403,9 +3273,7 @@ for (const value of buf) {
// 102
// 101
// 114
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3450,7 +3318,7 @@ Writes `string` to `buf` at `offset` according to the character encoding in
not contain enough space to fit the entire string, only part of `string` will be
written. However, partially encoded characters will not be written.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(256);
@@ -3466,9 +3334,7 @@ const length = buffer.write('abcd', 8);
console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// Prints: 2 bytes : ab
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(256);
@@ -3499,7 +3365,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3508,9 +3374,7 @@ buf.writeBigInt64BE(0x0102030405060708n, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3534,7 +3398,7 @@ Writes `value` to `buf` at the specified `offset` as little-endian.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3543,9 +3407,7 @@ buf.writeBigInt64LE(0x0102030405060708n, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3569,7 +3431,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian.
This function is also available under the `writeBigUint64BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3578,9 +3440,7 @@ buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3602,7 +3462,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as little-endian
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3611,9 +3471,7 @@ buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3639,7 +3497,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian. The `value`
must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3648,9 +3506,7 @@ buf.writeDoubleBE(123.456, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3674,7 +3530,7 @@ Writes `value` to `buf` at the specified `offset` as little-endian. The `value`
must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3683,9 +3539,7 @@ buf.writeDoubleLE(123.456, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3708,7 +3562,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3717,9 +3571,7 @@ buf.writeFloatBE(0xcafebabe, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3742,7 +3594,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3751,9 +3603,7 @@ buf.writeFloatLE(0xcafebabe, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3779,7 +3629,7 @@ a signed 8-bit integer.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3789,9 +3639,7 @@ buf.writeInt8(-2, 1);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3818,7 +3666,7 @@ anything other than a signed 16-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3827,9 +3675,7 @@ buf.writeInt16BE(0x0102, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3855,7 +3701,7 @@ anything other than a signed 16-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3864,9 +3710,7 @@ buf.writeInt16LE(0x0304, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3892,7 +3736,7 @@ anything other than a signed 32-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3901,9 +3745,7 @@ buf.writeInt32BE(0x01020304, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3929,7 +3771,7 @@ anything other than a signed 32-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3938,9 +3780,7 @@ buf.writeInt32LE(0x05060708, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3966,7 +3806,7 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when
`value` is anything other than a signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -3975,9 +3815,7 @@ buf.writeIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4003,7 +3841,7 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than a signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4012,9 +3850,7 @@ buf.writeIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4040,7 +3876,7 @@ other than an unsigned 8-bit integer.
This function is also available under the `writeUint8` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4052,9 +3888,7 @@ buf.writeUInt8(0x42, 3);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4083,7 +3917,7 @@ is anything other than an unsigned 16-bit integer.
This function is also available under the `writeUint16BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4093,9 +3927,7 @@ buf.writeUInt16BE(0xbeef, 2);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4122,7 +3954,7 @@ anything other than an unsigned 16-bit integer.
This function is also available under the `writeUint16LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4132,9 +3964,7 @@ buf.writeUInt16LE(0xbeef, 2);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4161,7 +3991,7 @@ is anything other than an unsigned 32-bit integer.
This function is also available under the `writeUint32BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4170,9 +4000,7 @@ buf.writeUInt32BE(0xfeedface, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4198,7 +4026,7 @@ anything other than an unsigned 32-bit integer.
This function is also available under the `writeUint32LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4207,9 +4035,7 @@ buf.writeUInt32LE(0xfeedface, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4237,7 +4063,7 @@ when `value` is anything other than an unsigned integer.
This function is also available under the `writeUintBE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4246,9 +4072,7 @@ buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4276,7 +4100,7 @@ when `value` is anything other than an unsigned integer.
This function is also available under the `writeUintLE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4285,9 +4109,7 @@ buf.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4476,6 +4298,18 @@ For code running using Node.js APIs, converting between base64-encoded strings
and binary data should be performed using `Buffer.from(str, 'base64')` and
`buf.toString('base64')`.**
+####
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const spkac = getSpkacSomehow();
const publicKey = Certificate.exportPublicKey(spkac);
@@ -151,18 +145,16 @@ console.log(publicKey);
* Returns: [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) `true` if the given `spkac` data structure is valid,
`false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { Certificate } = await import('node:crypto');
const spkac = getSpkacSomehow();
console.log(Certificate.verifySpkac(Buffer.from(spkac)));
// Prints: true or false
-```
-
-```cjs
-const { Certificate } = require('node:crypto');
+--------------
const { Buffer } = require('node:buffer');
+const { Certificate } = require('node:crypto');
const spkac = getSpkacSomehow();
console.log(Certificate.verifySpkac(Buffer.from(spkac)));
@@ -185,14 +177,12 @@ the `crypto.Certificate` class as illustrated in the examples below.
Instances of the `Certificate` class can be created using the `new` keyword
or by calling `crypto.Certificate()` as a function:
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert1 = new Certificate();
const cert2 = Certificate();
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert1 = new Certificate();
@@ -208,16 +198,14 @@ const cert2 = Certificate();
* Returns: [`Buffer`](/api/v18/buffer#buffer) The challenge component of the `spkac` data structure, which
includes a public key and a challenge.
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
const challenge = cert.exportChallenge(spkac);
console.log(challenge.toString('utf8'));
// Prints: the challenge as a UTF8 string
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -235,16 +223,14 @@ console.log(challenge.toString('utf8'));
* Returns: [`Buffer`](/api/v18/buffer#buffer) The public key component of the `spkac` data structure,
which includes a public key and a challenge.
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
const publicKey = cert.exportPublicKey(spkac);
console.log(publicKey);
// Prints: the public key as
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -262,7 +248,7 @@ console.log(publicKey);
* Returns: [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) `true` if the given `spkac` data structure is valid,
`false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { Certificate } = await import('node:crypto');
@@ -270,11 +256,9 @@ const cert = Certificate();
const spkac = getSpkacSomehow();
console.log(cert.verifySpkac(Buffer.from(spkac)));
// Prints: true or false
-```
-
-```cjs
-const { Certificate } = require('node:crypto');
+--------------
const { Buffer } = require('node:buffer');
+const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -302,7 +286,7 @@ directly using the `new` keyword.
Example: Using `Cipher` objects as streams:
-```mjs
+```mjs|cjs
const {
scrypt,
randomFill,
@@ -333,9 +317,7 @@ scrypt(password, 'salt', 24, (err, key) => {
cipher.end();
});
});
-```
-
-```cjs
+--------------
const {
scrypt,
randomFill,
@@ -370,7 +352,7 @@ scrypt(password, 'salt', 24, (err, key) => {
Example: Using `Cipher` and piped streams:
-```mjs
+```mjs|cjs
import {
createReadStream,
createWriteStream,
@@ -407,9 +389,7 @@ scrypt(password, 'salt', 24, (err, key) => {
});
});
});
-```
-
-```cjs
+--------------
const {
createReadStream,
createWriteStream,
@@ -450,7 +430,7 @@ scrypt(password, 'salt', 24, (err, key) => {
Example: Using the [`cipher.update()`][] and [`cipher.final()`][] methods:
-```mjs
+```mjs|cjs
const {
scrypt,
randomFill,
@@ -475,9 +455,7 @@ scrypt(password, 'salt', 24, (err, key) => {
console.log(encrypted);
});
});
-```
-
-```cjs
+--------------
const {
scrypt,
randomFill,
@@ -618,7 +596,7 @@ directly using the `new` keyword.
Example: Using `Decipher` objects as streams:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
scryptSync,
@@ -653,9 +631,7 @@ const encrypted =
'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';
decipher.write(encrypted, 'hex');
decipher.end();
-```
-
-```cjs
+--------------
const {
scryptSync,
createDecipheriv,
@@ -694,7 +670,7 @@ decipher.end();
Example: Using `Decipher` and piped streams:
-```mjs
+```mjs|cjs
import {
createReadStream,
createWriteStream,
@@ -718,9 +694,7 @@ const input = createReadStream('test.enc');
const output = createWriteStream('test.js');
input.pipe(decipher).pipe(output);
-```
-
-```cjs
+--------------
const {
createReadStream,
createWriteStream,
@@ -748,7 +722,7 @@ input.pipe(decipher).pipe(output);
Example: Using the [`decipher.update()`][] and [`decipher.final()`][] methods:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
scryptSync,
@@ -771,9 +745,7 @@ let decrypted = decipher.update(encrypted, 'hex', 'utf8');
decrypted += decipher.final('utf8');
console.log(decrypted);
// Prints: some clear text data
-```
-
-```cjs
+--------------
const {
scryptSync,
createDecipheriv,
@@ -911,7 +883,7 @@ exchanges.
Instances of the `DiffieHellman` class can be created using the
[`crypto.createDiffieHellman()`][] function.
-```mjs
+```mjs|cjs
import assert from 'node:assert';
const {
@@ -932,9 +904,7 @@ const bobSecret = bob.computeSecret(aliceKey);
// OK
assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
-```
-
-```cjs
+--------------
const assert = require('node:assert');
const {
@@ -984,12 +954,17 @@ If `outputEncoding` is given a string is returned; otherwise, a
* `encoding` [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) The [encoding][] of the return value.
* Returns: [`Buffer`](/api/v18/buffer#buffer) | [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
-Generates private and public Diffie-Hellman key values, and returns
+Generates private and public Diffie-Hellman key values unless they have been
+generated or computed already, and returns
the public key in the specified `encoding`. This key should be
transferred to the other party.
If `encoding` is provided a string is returned; otherwise a
[`Buffer`][] is returned.
+This function is a thin wrapper around [`DH_generate_key()`][]. In particular,
+once a private key has been generated or set, calling this function only updates
+the public key but does not generate a new private key.
+
####
SSL_OP_ALLApplies multiple bug workarounds within OpenSSL. See
- https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html
+ https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html
for detail.
@@ -4896,13 +4789,13 @@ See the [list of SSL OP Flags][] for details.
SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATIONAllows legacy insecure renegotiation between OpenSSL and unpatched
clients or servers. See
- https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html .
+ https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html .
SSL_OP_CIPHER_SERVER_PREFERENCEAttempts to use the server's preferences instead of the client's when
selecting a cipher. Behavior depends on protocol version. See
- https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html .
+ https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html .
SSL_OP_CISCO_ANYCONNECTInstructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability
workaround added in OpenSSL 0.9.6d.
-
- SSL_OP_EPHEMERAL_RSAInstructs OpenSSL to always use the tmp_rsa key when performing RSA
- operations.
-
SSL_OP_LEGACY_SERVER_CONNECTAllows initial connection to servers that do not support RI.
-
- SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
-
- SSL_OP_MICROSOFT_SESS_ID_BUG
-
- SSL_OP_MSIE_SSLV2_RSA_PADDINGInstructs OpenSSL to disable the workaround for a man-in-the-middle
- protocol-version vulnerability in the SSL 2.0 server implementation.
-
-
- SSL_OP_NETSCAPE_CA_DN_BUG
-
- SSL_OP_NETSCAPE_CHALLENGE_BUG
-
- SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG
-
- SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
SSL_OP_NO_COMPRESSIONInstructs OpenSSL to disable support for SSL/TLS compression.
@@ -5009,14 +4868,6 @@ See the [list of SSL OP Flags][] for details.
SSL_OP_NO_TLSv1_3Instructs OpenSSL to turn off TLS v1.3
-
- SSL_OP_PKCS1_CHECK_1
-
- SSL_OP_PKCS1_CHECK_2
SSL_OP_PRIORITIZE_CHACHAInstructs OpenSSL server to prioritize ChaCha20-Poly1305
@@ -5025,32 +4876,6 @@ See the [list of SSL OP Flags][] for details.
SSL_OP_CIPHER_SERVER_PREFERENCE
is not enabled.
-
- SSL_OP_SINGLE_DH_USEInstructs OpenSSL to always create a new key when using
- temporary/ephemeral DH parameters.
-
-
- SSL_OP_SINGLE_ECDH_USEInstructs OpenSSL to always create a new key when using
- temporary/ephemeral ECDH parameters.
-
-
- SSL_OP_SSLEAY_080_CLIENT_DH_BUG
-
- SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
-
- SSL_OP_TLS_BLOCK_PADDING_BUG
-
- SSL_OP_TLS_D5_BUG
SSL_OP_TLS_ROLLBACK_BUGInstructs OpenSSL to disable version rollback attack detection.
@@ -5233,6 +5058,7 @@ See the [list of SSL OP Flags][] for details.
[Web Crypto API documentation]: /api/v18/webcrypto
[`BN_is_prime_ex`]: https://www.openssl.org/docs/man1.1.1/man3/BN_is_prime_ex.html
[`Buffer`]: /api/v18/buffer
+[`DH_generate_key()`]: https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html
[`DiffieHellmanGroup`]: #class-diffiehellmangroup
[`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html
[`KeyObject`]: #class-keyobject
@@ -5269,6 +5095,7 @@ See the [list of SSL OP Flags][] for details.
[`crypto.webcrypto.subtle`]: /api/v18/webcrypto#class-subtlecrypto
[`decipher.final()`]: #decipherfinaloutputencoding
[`decipher.update()`]: #decipherupdatedata-inputencoding-outputencoding
+[`diffieHellman.generateKeys()`]: #diffiehellmangeneratekeysencoding
[`diffieHellman.setPublicKey()`]: #diffiehellmansetpublickeypublickey-encoding
[`ecdh.generateKeys()`]: #ecdhgeneratekeysencoding-format
[`ecdh.setPrivateKey()`]: #ecdhsetprivatekeyprivatekey-encoding
diff --git a/content/api/v18/debugger.en.md b/content/api/v18/debugger.en.md
index 13b63ea36d..5c0a921404 100644
--- a/content/api/v18/debugger.en.md
+++ b/content/api/v18/debugger.en.md
@@ -206,11 +206,19 @@ debug>
after)
* `watch(expr)`: Add expression to watch list
* `unwatch(expr)`: Remove expression from watch list
+* `unwatch(index)`: Remove expression at specific index from watch list
* `watchers`: List all watchers and their values (automatically listed on each
breakpoint)
* `repl`: Open debugger's repl for evaluation in debugging script's context
* `exec expr`, `p expr`: Execute an expression in debugging script's context and
print its value
+* `profile`: Start CPU profiling session
+* `profileEnd`: Stop current CPU profiling session
+* `profiles`: List all completed CPU profiling sessions
+* `profiles[n].save(filepath = 'node.cpuprofile')`: Save CPU profiling session
+ to disk as JSON
+* `takeHeapSnapshot(filepath = 'node.heapsnapshot')`: Take a heap snapshot
+ and save to disk as JSON
#### Execution control
diff --git a/content/api/v18/deprecations.en.md b/content/api/v18/deprecations.en.md
index 4f2022ebcb..2b677f8310 100644
--- a/content/api/v18/deprecations.en.md
+++ b/content/api/v18/deprecations.en.md
@@ -1864,7 +1864,7 @@ In a future version of Node.js, [`message.headers`][],
[`dnsPromises.lookup()`]: /api/v18/dns#dnspromiseslookuphostname-options
[`domain`]: /api/v18/domain
[`ecdh.setPublicKey()`]: /api/v18/crypto#ecdhsetpublickeypublickey-encoding
-[`emitter.listenerCount(eventName)`]: /api/v18/events#emitterlistenercounteventname
+[`emitter.listenerCount(eventName)`]: /api/v18/events#emitterlistenercounteventname-listener
[`events.listenerCount(emitter, eventName)`]: /api/v18/events#eventslistenercountemitter-eventname
[`fs.FileHandle`]: /api/v18/fs#class-filehandle
[`fs.access()`]: /api/v18/fs#fsaccesspath-mode-callback
diff --git a/content/api/v18/dgram.en.md b/content/api/v18/dgram.en.md
index 512812357b..ff64e61bd1 100644
--- a/content/api/v18/dgram.en.md
+++ b/content/api/v18/dgram.en.md
@@ -15,11 +15,11 @@ Stable
Hello World ');
});
-server.listen(80);
+server.listen(8000);
```
Even though HTTP/2 streams and network sockets are not in a 1:1 correspondence,
@@ -2158,7 +2158,7 @@ server.on('stream', (stream, headers) => {
stream.end('Hello World ');
});
-server.listen(80);
+server.listen(8000);
```
#### Hello World ');
});
-server.listen(80);
+server.listen(8443);
```
####
napi_value create_addon(napi_env env);
#endif // _ADDON_H_
-```
-
-```c
+--------------
// addon.c
#include "addon.h"
@@ -5727,12 +5723,10 @@ Experimental
-```c
+```c|text
NAPI_EXTERN napi_status
node_api_get_module_file_name(napi_env env, const char** result);
-```
-
* `[in] env`: The environment that the API is invoked under.
* `[out] result`: A URL containing the absolute path of the
location from which the add-on was loaded. For a file on the local
diff --git a/content/api/v18/navigation.json b/content/api/v18/navigation.json
index 9c3a0efd67..d231687cf6 100644
--- a/content/api/v18/navigation.json
+++ b/content/api/v18/navigation.json
@@ -1,4 +1,1775 @@
{
"version": "v18",
- "items": []
+ "items": [
+ {
+ "slug": "/api/v18/addons/",
+ "title": "C addons",
+ "type": "module",
+ "name": "addons"
+ },
+ {
+ "slug": "/api/v18/assert/",
+ "title": "Assert",
+ "type": "module",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v18/assert/#assertassertionerror",
+ "title": "assertAssertionError",
+ "type": "class",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v18/assert/#assertcalltracker",
+ "title": "assertCallTracker",
+ "type": "class",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v18/async_context/",
+ "title": "Asynchronous context tracking",
+ "type": "module",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v18/async_context/#asynclocalstorage",
+ "title": "AsyncLocalStorage",
+ "type": "class",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v18/async_context/#asyncresource",
+ "title": "AsyncResource",
+ "type": "class",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v18/async_hooks/",
+ "title": "Async hooks",
+ "type": "module",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v18/async_hooks/#asynchook",
+ "title": "AsyncHook",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v18/async_hooks/#asynclocalstorage",
+ "title": "AsyncLocalStorage",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v18/async_hooks/#asyncresource",
+ "title": "AsyncResource",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v18/buffer/",
+ "title": "Buffer",
+ "type": "module",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v18/buffer/#blob",
+ "title": "Blob",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v18/buffer/#buffer",
+ "title": "Buffer",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v18/buffer/#file",
+ "title": "File",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v18/buffer/#slowbuffer",
+ "title": "SlowBuffer",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v18/child_process/",
+ "title": "Child process",
+ "type": "module",
+ "name": "child_process"
+ },
+ {
+ "slug": "/api/v18/child_process/#childprocess",
+ "title": "ChildProcess",
+ "type": "class",
+ "name": "child_process"
+ },
+ {
+ "slug": "/api/v18/cli/",
+ "title": "Command-line API",
+ "type": "module",
+ "name": "cli"
+ },
+ {
+ "slug": "/api/v18/cluster/",
+ "title": "Cluster",
+ "type": "module",
+ "name": "cluster"
+ },
+ {
+ "slug": "/api/v18/cluster/#worker",
+ "title": "Worker",
+ "type": "class",
+ "name": "cluster"
+ },
+ {
+ "slug": "/api/v18/console/",
+ "title": "Console",
+ "type": "module",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v18/console/#console",
+ "title": "Console",
+ "type": "class",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v18/console/#console",
+ "title": "Console",
+ "type": "class",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v18/corepack/",
+ "title": "Corepack",
+ "type": "module",
+ "name": "corepack"
+ },
+ {
+ "slug": "/api/v18/crypto/",
+ "title": "Crypto",
+ "type": "module",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#certificate",
+ "title": "Certificate",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#cipher",
+ "title": "Cipher",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#decipher",
+ "title": "Decipher",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#diffiehellman",
+ "title": "DiffieHellman",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#diffiehellmangroup",
+ "title": "DiffieHellmanGroup",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#ecdh",
+ "title": "ECDH",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#hash",
+ "title": "Hash",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#hmac",
+ "title": "Hmac",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#keyobject",
+ "title": "KeyObject",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#sign",
+ "title": "Sign",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#verify",
+ "title": "Verify",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/crypto/#x509certificate",
+ "title": "X509Certificate",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v18/debugger/",
+ "title": "Debugger",
+ "type": "module",
+ "name": "debugger"
+ },
+ {
+ "slug": "/api/v18/deprecations/",
+ "title": "Deprecated APIs",
+ "type": "module",
+ "name": "deprecations"
+ },
+ {
+ "slug": "/api/v18/dgram/",
+ "title": "UDPdatagram sockets",
+ "type": "module",
+ "name": "dgram"
+ },
+ {
+ "slug": "/api/v18/dgram/#dgramsocket",
+ "title": "dgramSocket",
+ "type": "class",
+ "name": "dgram"
+ },
+ {
+ "slug": "/api/v18/diagnostics_channel/",
+ "title": "Diagnostics Channel",
+ "type": "module",
+ "name": "diagnostics_channel"
+ },
+ {
+ "slug": "/api/v18/diagnostics_channel/#channel",
+ "title": "Channel",
+ "type": "class",
+ "name": "diagnostics_channel"
+ },
+ {
+ "slug": "/api/v18/dns/",
+ "title": "DNS",
+ "type": "module",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v18/dns/#dnspromisesresolver",
+ "title": "dnsPromisesResolver",
+ "type": "class",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v18/dns/#dnsresolver",
+ "title": "dnsResolver",
+ "type": "class",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v18/documentation/",
+ "title": "About this documentation",
+ "type": "module",
+ "name": "documentation"
+ },
+ {
+ "slug": "/api/v18/domain/",
+ "title": "Domain",
+ "type": "module",
+ "name": "domain"
+ },
+ {
+ "slug": "/api/v18/domain/#domain",
+ "title": "Domain",
+ "type": "class",
+ "name": "domain"
+ },
+ {
+ "slug": "/api/v18/embedding/",
+ "title": "C embedder API",
+ "type": "module",
+ "name": "embedding"
+ },
+ {
+ "slug": "/api/v18/errors/",
+ "title": "Errors",
+ "type": "module",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/errors/#assertionerror",
+ "title": "AssertionError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/errors/#error",
+ "title": "Error",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/errors/#rangeerror",
+ "title": "RangeError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/errors/#referenceerror",
+ "title": "ReferenceError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/errors/#syntaxerror",
+ "title": "SyntaxError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/errors/#systemerror",
+ "title": "SystemError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/errors/#typeerror",
+ "title": "TypeError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v18/esm/",
+ "title": "ECMAScript modules",
+ "type": "module",
+ "name": "esm"
+ },
+ {
+ "slug": "/api/v18/events/",
+ "title": "Events",
+ "type": "module",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v18/events/#customevent",
+ "title": "CustomEvent",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v18/events/#event",
+ "title": "Event",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v18/events/#eventemitter",
+ "title": "EventEmitter",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v18/events/#eventseventemitterasyncresource-extends-eventemitter",
+ "title": "eventsEventEmitterAsyncResource extends EventEmitter",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v18/events/#eventtarget",
+ "title": "EventTarget",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v18/events/#nodeeventtarget",
+ "title": "NodeEventTarget",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v18/fs/",
+ "title": "File system",
+ "type": "module",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#filehandle",
+ "title": "FileHandle",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fsdir",
+ "title": "fsDir",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fsdirent",
+ "title": "fsDirent",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fsfswatcher",
+ "title": "fsFSWatcher",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fsreadstream",
+ "title": "fsReadStream",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fsstatfs",
+ "title": "fsStatFs",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fsstats",
+ "title": "fsStats",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fsstatwatcher",
+ "title": "fsStatWatcher",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/fs/#fswritestream",
+ "title": "fsWriteStream",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v18/globals/",
+ "title": "Global objects",
+ "type": "module",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#abortcontroller",
+ "title": "AbortController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#abortcontroller",
+ "title": "AbortController",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#abortsignal",
+ "title": "AbortSignal",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#blob",
+ "title": "Blob",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#blob",
+ "title": "Blob",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#buffer",
+ "title": "Buffer",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#buffer",
+ "title": "Buffer",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#bytelengthqueuingstrategy",
+ "title": "ByteLengthQueuingStrategy",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#clearimmediateimmediateobject",
+ "title": "clearImmediate",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#clearintervalintervalobject",
+ "title": "clearInterval",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#cleartimeouttimeoutobject",
+ "title": "clearTimeout",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#compressionstream",
+ "title": "CompressionStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#console",
+ "title": "console",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#countqueuingstrategy",
+ "title": "CountQueuingStrategy",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#customevent",
+ "title": "CustomEvent",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#decompressionstream",
+ "title": "DecompressionStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#domexception",
+ "title": "DOMException",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#event",
+ "title": "Event",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#eventtarget",
+ "title": "EventTarget",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#global",
+ "title": "global",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#messagechannel",
+ "title": "MessageChannel",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#messageevent",
+ "title": "MessageEvent",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#messageport",
+ "title": "MessagePort",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#process",
+ "title": "process",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#queuemicrotaskcallback",
+ "title": "queueMicrotask",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#readablebytestreamcontroller",
+ "title": "ReadableByteStreamController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#readablestream",
+ "title": "ReadableStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#readablestreambyobreader",
+ "title": "ReadableStreamBYOBReader",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#readablestreambyobrequest",
+ "title": "ReadableStreamBYOBRequest",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#readablestreamdefaultcontroller",
+ "title": "ReadableStreamDefaultController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#readablestreamdefaultreader",
+ "title": "ReadableStreamDefaultReader",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#setimmediatecallback-args",
+ "title": "setImmediate",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#setintervalcallback-delay-args",
+ "title": "setInterval",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#settimeoutcallback-delay-args",
+ "title": "setTimeout",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#structuredclonevalue-options",
+ "title": "structuredClone",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#textdecoder",
+ "title": "TextDecoder",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#textdecoderstream",
+ "title": "TextDecoderStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#textencoder",
+ "title": "TextEncoder",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#textencoderstream",
+ "title": "TextEncoderStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#transformstream",
+ "title": "TransformStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#transformstreamdefaultcontroller",
+ "title": "TransformStreamDefaultController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#url",
+ "title": "URL",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#urlsearchparams",
+ "title": "URLSearchParams",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#webassembly",
+ "title": "WebAssembly",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#writablestream",
+ "title": "WritableStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#writablestreamdefaultcontroller",
+ "title": "WritableStreamDefaultController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/globals/#writablestreamdefaultwriter",
+ "title": "WritableStreamDefaultWriter",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v18/http/",
+ "title": "HTTP",
+ "type": "module",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v18/http/#httpagent",
+ "title": "httpAgent",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v18/http/#httpclientrequest",
+ "title": "httpClientRequest",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v18/http/#httpincomingmessage",
+ "title": "httpIncomingMessage",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v18/http/#httpoutgoingmessage",
+ "title": "httpOutgoingMessage",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v18/http/#httpserver",
+ "title": "httpServer",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v18/http/#httpserverresponse",
+ "title": "httpServerResponse",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v18/http2/",
+ "title": "HTTP2",
+ "type": "module",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#clienthttp2session",
+ "title": "ClientHttp2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#clienthttp2stream",
+ "title": "ClientHttp2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#http2http2serverrequest",
+ "title": "http2Http2ServerRequest",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#http2http2serverresponse",
+ "title": "http2Http2ServerResponse",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#http2secureserver",
+ "title": "Http2SecureServer",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#http2server",
+ "title": "Http2Server",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#http2session",
+ "title": "Http2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#http2stream",
+ "title": "Http2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#serverhttp2session",
+ "title": "ServerHttp2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/http2/#serverhttp2stream",
+ "title": "ServerHttp2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v18/https/",
+ "title": "HTTPS",
+ "type": "module",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v18/https/#httpsagent",
+ "title": "httpsAgent",
+ "type": "class",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v18/https/#httpsserver",
+ "title": "httpsServer",
+ "type": "class",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v18/inspector/",
+ "title": "Inspector",
+ "type": "module",
+ "name": "inspector"
+ },
+ {
+ "slug": "/api/v18/inspector/#inspectorsession",
+ "title": "inspectorSession",
+ "type": "class",
+ "name": "inspector"
+ },
+ {
+ "slug": "/api/v18/intl/",
+ "title": "Internationalization support",
+ "type": "module",
+ "name": "intl"
+ },
+ {
+ "slug": "/api/v18/module/",
+ "title": "nodemodule API",
+ "type": "module",
+ "name": "module"
+ },
+ {
+ "slug": "/api/v18/module/#modulesourcemap",
+ "title": "moduleSourceMap",
+ "type": "class",
+ "name": "module"
+ },
+ {
+ "slug": "/api/v18/modules/",
+ "title": "CommonJS modules",
+ "type": "module",
+ "name": "modules"
+ },
+ {
+ "slug": "/api/v18/n-api/",
+ "title": "Node-API",
+ "type": "module",
+ "name": "n-api"
+ },
+ {
+ "slug": "/api/v18/net/",
+ "title": "Net",
+ "type": "module",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v18/net/#netblocklist",
+ "title": "netBlockList",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v18/net/#netserver",
+ "title": "netServer",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v18/net/#netsocket",
+ "title": "netSocket",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v18/net/#netsocketaddress",
+ "title": "netSocketAddress",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v18/os/",
+ "title": "OS",
+ "type": "module",
+ "name": "os"
+ },
+ {
+ "slug": "/api/v18/packages/",
+ "title": "Packages",
+ "type": "module",
+ "name": "packages"
+ },
+ {
+ "slug": "/api/v18/path/",
+ "title": "Path",
+ "type": "module",
+ "name": "path"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/",
+ "title": "Performance measurement APIs",
+ "type": "module",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#histogram",
+ "title": "Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#intervalhistogram-extends-histogram",
+ "title": "IntervalHistogram extends Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#perf-hooksperformanceobserver",
+ "title": "perf_hooksPerformanceObserver",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#performanceentry",
+ "title": "PerformanceEntry",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#performancenodetiming",
+ "title": "PerformanceNodeTiming",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#performanceobserverentrylist",
+ "title": "PerformanceObserverEntryList",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#performanceresourcetiming",
+ "title": "PerformanceResourceTiming",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/perf_hooks/#recordablehistogram-extends-histogram",
+ "title": "RecordableHistogram extends Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v18/permissions/",
+ "title": "Permissions",
+ "type": "module",
+ "name": "permissions"
+ },
+ {
+ "slug": "/api/v18/policy/",
+ "title": "Policies",
+ "type": "module",
+ "name": "policy"
+ },
+ {
+ "slug": "/api/v18/process/",
+ "title": "Process",
+ "type": "module",
+ "name": "process"
+ },
+ {
+ "slug": "/api/v18/punycode/",
+ "title": "Punycode",
+ "type": "module",
+ "name": "punycode"
+ },
+ {
+ "slug": "/api/v18/querystring/",
+ "title": "Query string",
+ "type": "module",
+ "name": "querystring"
+ },
+ {
+ "slug": "/api/v18/readline/",
+ "title": "Readline",
+ "type": "module",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v18/readline/#interfaceconstructor",
+ "title": "InterfaceConstructor",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v18/readline/#readlineinterface",
+ "title": "readlineInterface",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v18/readline/#readlinepromisesinterface",
+ "title": "readlinePromisesInterface",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v18/readline/#readlinepromisesreadline",
+ "title": "readlinePromisesReadline",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v18/repl/",
+ "title": "REPL",
+ "type": "module",
+ "name": "repl"
+ },
+ {
+ "slug": "/api/v18/repl/#replserver",
+ "title": "REPLServer",
+ "type": "class",
+ "name": "repl"
+ },
+ {
+ "slug": "/api/v18/report/",
+ "title": "Diagnostic report",
+ "type": "module",
+ "name": "report"
+ },
+ {
+ "slug": "/api/v18/single-executable-applications/",
+ "title": "Single executable applications",
+ "type": "module",
+ "name": "single-executable-applications"
+ },
+ {
+ "slug": "/api/v18/stream/",
+ "title": "Stream",
+ "type": "module",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamduplex",
+ "title": "streamDuplex",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamduplex",
+ "title": "streamDuplex",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streampassthrough",
+ "title": "streamPassThrough",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamreadable",
+ "title": "streamReadable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamreadable",
+ "title": "streamReadable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamtransform",
+ "title": "streamTransform",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamtransform",
+ "title": "streamTransform",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamwritable",
+ "title": "streamWritable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/stream/#streamwritable",
+ "title": "streamWritable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v18/string_decoder/",
+ "title": "String decoder",
+ "type": "module",
+ "name": "string_decoder"
+ },
+ {
+ "slug": "/api/v18/string_decoder/#stringdecoder",
+ "title": "StringDecoder",
+ "type": "class",
+ "name": "string_decoder"
+ },
+ {
+ "slug": "/api/v18/synopsis/",
+ "title": "Usage and example",
+ "type": "module",
+ "name": "synopsis"
+ },
+ {
+ "slug": "/api/v18/test/",
+ "title": "Test runner",
+ "type": "module",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v18/test/#mockfunctioncontext",
+ "title": "MockFunctionContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v18/test/#mocktracker",
+ "title": "MockTracker",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v18/test/#suitecontext",
+ "title": "SuiteContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v18/test/#testcontext",
+ "title": "TestContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v18/test/#testsstream",
+ "title": "TestsStream",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v18/timers/",
+ "title": "Timers",
+ "type": "module",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v18/timers/#immediate",
+ "title": "Immediate",
+ "type": "class",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v18/timers/#timeout",
+ "title": "Timeout",
+ "type": "class",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v18/tls/",
+ "title": "TLS ",
+ "type": "module",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v18/tls/#tlscryptostream",
+ "title": "tlsCryptoStream",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v18/tls/#tlssecurepair",
+ "title": "tlsSecurePair",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v18/tls/#tlsserver",
+ "title": "tlsServer",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v18/tls/#tlstlssocket",
+ "title": "tlsTLSSocket",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v18/tracing/",
+ "title": "Trace events",
+ "type": "module",
+ "name": "tracing"
+ },
+ {
+ "slug": "/api/v18/tty/",
+ "title": "TTY",
+ "type": "module",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v18/tty/#ttyreadstream",
+ "title": "ttyReadStream",
+ "type": "class",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v18/tty/#ttywritestream",
+ "title": "ttyWriteStream",
+ "type": "class",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v18/url/",
+ "title": "URL",
+ "type": "module",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v18/url/#url",
+ "title": "URL",
+ "type": "class",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v18/url/#urlsearchparams",
+ "title": "URLSearchParams",
+ "type": "class",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v18/util/",
+ "title": "Util",
+ "type": "module",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v18/util/#utilmimeparams",
+ "title": "utilMIMEParams",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v18/util/#utilmimetype",
+ "title": "utilMIMEType",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v18/util/#utiltextdecoder",
+ "title": "utilTextDecoder",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v18/util/#utiltextencoder",
+ "title": "utilTextEncoder",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v18/v8/",
+ "title": "V8",
+ "type": "module",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v18/v8/#v8defaultdeserializer",
+ "title": "v8DefaultDeserializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v18/v8/#v8defaultserializer",
+ "title": "v8DefaultSerializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v18/v8/#v8deserializer",
+ "title": "v8Deserializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v18/v8/#v8gcprofiler",
+ "title": "v8GCProfiler",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v18/v8/#v8serializer",
+ "title": "v8Serializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v18/vm/",
+ "title": "VM ",
+ "type": "module",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v18/vm/#vmmodule",
+ "title": "vmModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v18/vm/#vmscript",
+ "title": "vmScript",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v18/vm/#vmsourcetextmodule",
+ "title": "vmSourceTextModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v18/vm/#vmsyntheticmodule",
+ "title": "vmSyntheticModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v18/wasi/",
+ "title": "WebAssembly System Interface ",
+ "type": "module",
+ "name": "wasi"
+ },
+ {
+ "slug": "/api/v18/wasi/#wasi",
+ "title": "WASI",
+ "type": "class",
+ "name": "wasi"
+ },
+ {
+ "slug": "/api/v18/webcrypto/",
+ "title": "Web Crypto API",
+ "type": "module",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#aescbcparams",
+ "title": "AesCbcParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#aesctrparams",
+ "title": "AesCtrParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#aesgcmparams",
+ "title": "AesGcmParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#aeskeygenparams",
+ "title": "AesKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#algorithmidentifier",
+ "title": "AlgorithmIdentifier",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#crypto",
+ "title": "Crypto",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#cryptokey",
+ "title": "CryptoKey",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#cryptokeypair",
+ "title": "CryptoKeyPair",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#ecdhkeyderiveparams",
+ "title": "EcdhKeyDeriveParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#ecdsaparams",
+ "title": "EcdsaParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#eckeygenparams",
+ "title": "EcKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#eckeyimportparams",
+ "title": "EcKeyImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#ed448params",
+ "title": "Ed448Params",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#hkdfparams",
+ "title": "HkdfParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#hmacimportparams",
+ "title": "HmacImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#hmackeygenparams",
+ "title": "HmacKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#pbkdf2params",
+ "title": "Pbkdf2Params",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#rsahashedimportparams",
+ "title": "RsaHashedImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#rsahashedkeygenparams",
+ "title": "RsaHashedKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#rsaoaepparams",
+ "title": "RsaOaepParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#rsapssparams",
+ "title": "RsaPssParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webcrypto/#subtlecrypto",
+ "title": "SubtleCrypto",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v18/webstreams/",
+ "title": "Web Streams API",
+ "type": "module",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#bytelengthqueuingstrategy",
+ "title": "ByteLengthQueuingStrategy",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#compressionstream",
+ "title": "CompressionStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#countqueuingstrategy",
+ "title": "CountQueuingStrategy",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#decompressionstream",
+ "title": "DecompressionStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#readablebytestreamcontroller",
+ "title": "ReadableByteStreamController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#readablestream",
+ "title": "ReadableStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#readablestreambyobreader",
+ "title": "ReadableStreamBYOBReader",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#readablestreambyobrequest",
+ "title": "ReadableStreamBYOBRequest",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#readablestreamdefaultcontroller",
+ "title": "ReadableStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#readablestreamdefaultreader",
+ "title": "ReadableStreamDefaultReader",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#textdecoderstream",
+ "title": "TextDecoderStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#textencoderstream",
+ "title": "TextEncoderStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#transformstream",
+ "title": "TransformStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#transformstreamdefaultcontroller",
+ "title": "TransformStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#writablestream",
+ "title": "WritableStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#writablestreamdefaultcontroller",
+ "title": "WritableStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/webstreams/#writablestreamdefaultwriter",
+ "title": "WritableStreamDefaultWriter",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v18/worker_threads/",
+ "title": "Worker threads",
+ "type": "module",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v18/worker_threads/#broadcastchannel-extends-eventtarget",
+ "title": "BroadcastChannel extends EventTarget",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v18/worker_threads/#messagechannel",
+ "title": "MessageChannel",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v18/worker_threads/#messageport",
+ "title": "MessagePort",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v18/worker_threads/#worker",
+ "title": "Worker",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v18/zlib/",
+ "title": "Zlib",
+ "type": "module",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#brotlioptions",
+ "title": "BrotliOptions",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#options",
+ "title": "Options",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibbrotlicompress",
+ "title": "zlibBrotliCompress",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibbrotlidecompress",
+ "title": "zlibBrotliDecompress",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibdeflate",
+ "title": "zlibDeflate",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibdeflateraw",
+ "title": "zlibDeflateRaw",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibgunzip",
+ "title": "zlibGunzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibgzip",
+ "title": "zlibGzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibinflate",
+ "title": "zlibInflate",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibinflateraw",
+ "title": "zlibInflateRaw",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibunzip",
+ "title": "zlibUnzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v18/zlib/#zlibzlibbase",
+ "title": "zlibZlibBase",
+ "type": "class",
+ "name": "zlib"
+ }
+ ]
}
\ No newline at end of file
diff --git a/content/api/v18/net.en.md b/content/api/v18/net.en.md
index cecc42979c..e4c94566b9 100644
--- a/content/api/v18/net.en.md
+++ b/content/api/v18/net.en.md
@@ -13,7 +13,7 @@ Stable
-)
// at main (*)
// First call
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('multipleResolves', (type, promise, reason) => {
@@ -291,7 +281,7 @@ In asynchronous code, the `'unhandledRejection'` event is emitted when the list
of unhandled rejections grows, and the `'rejectionHandled'` event is emitted
when the list of unhandled rejections shrinks.
-```mjs
+```mjs|cjs
import process from 'node:process';
const unhandledRejections = new Map();
@@ -301,9 +291,7 @@ process.on('unhandledRejection', (reason, promise) => {
process.on('rejectionHandled', (promise) => {
unhandledRejections.delete(promise);
});
-```
-
-```cjs
+--------------
const process = require('node:process');
const unhandledRejections = new Map();
@@ -344,7 +332,7 @@ behavior. Alternatively, change the [`process.exitCode`][] in the
provided exit code. Otherwise, in the presence of such handler the process will
exit with 0.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('uncaughtException', (err, origin) => {
@@ -362,9 +350,7 @@ setTimeout(() => {
// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
console.log('This will not run.');
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('uncaughtException', (err, origin) => {
@@ -436,7 +422,7 @@ Installing an `'uncaughtExceptionMonitor'` listener does not change the behavior
once an `'uncaughtException'` event is emitted. The process will
still crash if no `'uncaughtException'` listener is installed.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('uncaughtExceptionMonitor', (err, origin) => {
@@ -446,9 +432,7 @@ process.on('uncaughtExceptionMonitor', (err, origin) => {
// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
// Still crashes Node.js
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('uncaughtExceptionMonitor', (err, origin) => {
@@ -476,7 +460,7 @@ are propagated through a `Promise` chain. The `'unhandledRejection'` event is
useful for detecting and keeping track of promises that were rejected whose
rejections have not yet been handled.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('unhandledRejection', (reason, promise) => {
@@ -487,9 +471,7 @@ process.on('unhandledRejection', (reason, promise) => {
somePromise.then((res) => {
return reportToUser(JSON.pasre(res)); // Note the typo (`pasre`)
}); // No `.catch()` or `.then()`
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('unhandledRejection', (reason, promise) => {
@@ -505,7 +487,7 @@ somePromise.then((res) => {
The following will also trigger the `'unhandledRejection'` event to be
emitted:
-```mjs
+```mjs|cjs
import process from 'node:process';
function SomeResource() {
@@ -515,9 +497,7 @@ function SomeResource() {
const resource = new SomeResource();
// no .catch or .then on resource.loaded for at least a turn
-```
-
-```cjs
+--------------
const process = require('node:process');
function SomeResource() {
@@ -554,7 +534,7 @@ are not part of the normal Node.js and JavaScript error handling flow.
Node.js can emit warnings whenever it detects bad coding practices that could
lead to sub-optimal application performance, bugs, or security vulnerabilities.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('warning', (warning) => {
@@ -562,9 +542,7 @@ process.on('warning', (warning) => {
console.warn(warning.message); // Print the warning message
console.warn(warning.stack); // Print the stack trace
});
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('warning', (warning) => {
@@ -671,7 +649,7 @@ The signal handler will receive the signal's name (`'SIGINT'`,
The name of each event will be the uppercase common name for the signal (e.g.
`'SIGINT'` for `SIGINT` signals).
-```mjs
+```mjs|cjs
import process from 'node:process';
// Begin reading from stdin so the process does not exit.
@@ -688,9 +666,7 @@ function handle(signal) {
process.on('SIGINT', handle);
process.on('SIGTERM', handle);
-```
-
-```cjs
+--------------
const process = require('node:process');
// Begin reading from stdin so the process does not exit.
@@ -793,7 +769,7 @@ appear only _once_; each will begin with one or more dashes. Flags
passed through to V8 will contain underscores instead of non-leading
dashes:
-```mjs
+```mjs|cjs
import { allowedNodeEnvironmentFlags } from 'node:process';
allowedNodeEnvironmentFlags.forEach((flag) => {
@@ -802,9 +778,7 @@ allowedNodeEnvironmentFlags.forEach((flag) => {
// --abort_on_uncaught_exception
// ...
});
-```
-
-```cjs
+--------------
const { allowedNodeEnvironmentFlags } = require('node:process');
allowedNodeEnvironmentFlags.forEach((flag) => {
@@ -833,13 +807,11 @@ The operating system CPU architecture for which the Node.js binary was compiled.
Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`,
`'ppc64'`, `'s390'`, `'s390x'`, and `'x64'`.
-```mjs
+```mjs|cjs
import { arch } from 'node:process';
console.log(`This processor architecture is ${arch}`);
-```
-
-```cjs
+--------------
const { arch } = require('node:process');
console.log(`This processor architecture is ${arch}`);
@@ -860,16 +832,14 @@ arguments.
For example, assuming the following script for `process-args.js`:
-```mjs
+```mjs|cjs
import { argv } from 'node:process';
// print process.argv
argv.forEach((val, index) => {
console.log(`${index}: ${val}`);
});
-```
-
-```cjs
+--------------
const { argv } = require('node:process');
// print process.argv
@@ -954,7 +924,7 @@ The `process.chdir()` method changes the current working directory of the
Node.js process or throws an exception if doing so fails (for instance, if
the specified `directory` does not exist).
-```mjs
+```mjs|cjs
import { chdir, cwd } from 'node:process';
console.log(`Starting directory: ${cwd()}`);
@@ -964,9 +934,7 @@ try {
} catch (err) {
console.error(`chdir: ${err}`);
}
-```
-
-```cjs
+--------------
const { chdir, cwd } = require('node:process');
console.log(`Starting directory: ${cwd()}`);
@@ -1043,6 +1011,25 @@ and [Cluster][] documentation), the `process.connected` property will return
Once `process.connected` is `false`, it is no longer possible to send messages
over the IPC channel using `process.send()`.
+###
+
+Experimental
+
+
+
+* [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) | [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type)
+
+Gets the amount of memory available to the process (in bytes) based on
+limits imposed by the OS. If there is no such constraint, or the constraint
+is unknown, `undefined` is returned.
+
+See [`uv_get_constrained_memory`][uv_get_constrained_memory] for more
+information.
+
###
+
+Experimental: This feature is being designed and will change.
+
+
+
+
@@ -2572,7 +2561,8 @@ const server = http.createServer((req, res) => {
-* `streams` Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]
+* `streams` Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]|
+ ReadableStream\[]|WritableStream\[]|TransformStream\[]
* Returns: [`stream.Duplex`](/api/v18/stream#streamduplex)
Combines two or more streams into a `Duplex` stream that writes to the
@@ -2777,8 +2767,14 @@ Experimental
* `streamReadable` [`stream.Readable`](/api/v18/stream#streamreadable)
* `options` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
* `strategy` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- * `highWaterMark` [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
- * `size` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
+ * `highWaterMark` [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) The maximum internal queue size (of the created
+ `ReadableStream`) before backpressure is applied in reading from the given
+ `stream.Readable`. If no value is provided, it will be taken from the
+ given `stream.Readable`.
+ * `size` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) A function that size of the given chunk of data.
+ If no value is provided, the size will be `1` for all the chunks.
+ * `chunk` [`any`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types)
+ * Returns: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
* Returns: [`ReadableStream`](/api/v18/webstreams#readablestream)
####
Experimental
-'` if `fn`
- does not have a name.
-* `options` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) Configuration options for the suite.
- supports the same options as `test([name][, options][, fn])`.
-* `fn` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) | [`AsyncFunction`](https://tc39.es/ecma262/#sec-async-function-constructor) The function under test.
- If the test uses callbacks, the callback function is passed as an argument.
- **Default:** A no-op function.
-* Returns: `undefined`.
+
+
+Experimental
+
+
+
+* `signal` [`AbortSignal`](/api/v18/globals#abortsignal)
+* `resource` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) Any non-null entity, reference to which is held weakly.
+* Returns: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+
+Listens to abort event on the provided `signal` and
+returns a promise that is fulfilled when the `signal` is
+aborted. If the passed `resource` is garbage collected before the `signal` is
+aborted, the returned promise shall remain pending indefinitely.
+
+```cjs|mjs
+const { aborted } = require('node:util');
+
+const dependent = obtainSomethingAbortable();
+
+aborted(dependent.signal, dependent).then(() => {
+ // Do something when dependent is aborted.
+});
+
+dependent.on('event', () => {
+ dependent.abort();
+});
+--------------
+import { aborted } from 'node:util';
+
+const dependent = obtainSomethingAbortable();
+
+aborted(dependent.signal, dependent).then(() => {
+ // Do something when dependent is aborted.
+});
+
+dependent.on('event', () => {
+ dependent.abort();
+});
+```
+
###
#include
napi_value result;
@@ -2029,9 +2050,7 @@ static napi_value MyNapi(napi_env env, napi_callback_info info) {
...
DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
...
-```
-
-```js
+--------------
const native = require('napi_addon.node');
const data = native.myNapi();
util.types.isExternal(data); // returns true
diff --git a/content/api/v18/v8.en.md b/content/api/v18/v8.en.md
index f1f94d420d..65a2ad69e1 100644
--- a/content/api/v18/v8.en.md
+++ b/content/api/v18/v8.en.md
@@ -7,7 +7,7 @@ version: 'v18'
+
+Experimental
+
+
+
+* `fn` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) The function to bind to the current execution context.
+* Returns: [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) A new function that calls `fn` within the captured
+ execution context.
+
+Binds the given function to the current execution context.
+
+#### Static method: `AsyncLocalStorage.snapshot()`
+
+
+
+Experimental
+
+
+
+* Returns: [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) A new function with the signature
+ `(fn: (...args) : R, ...args) : R`.
+
+Captures the current execution context and returns a function that accepts a
+function as an argument. Whenever the returned function is called, it
+calls the function passed to it within the captured context.
+
+```js
+const asyncLocalStorage = new AsyncLocalStorage();
+const runInAsyncScope = asyncLocalStorage.run(123, () => asyncLocalStorage.snapshot());
+const result = asyncLocalStorage.run(321, () => runInAsyncScope(() => asyncLocalStorage.getStore()));
+console.log(result); // returns 123
+```
+
+AsyncLocalStorage.snapshot() can replace the use of AsyncResource for simple
+async context tracking purposes, for example:
+
+```js
+class Foo {
+ #runInAsyncScope = AsyncLocalStorage.snapshot();
+
+ get() { return this.#runInAsyncScope(() => asyncLocalStorage.getStore()); }
+}
+
+const foo = asyncLocalStorage.run(123, () => new Foo());
+console.log(asyncLocalStorage.run(321, () => foo.get())); // returns 123
+```
+
####
console.log(Buffer.from('fhqwhgads', 'utf16le'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('hello world', 'utf8');
@@ -194,7 +190,7 @@ The following legacy character encodings are also supported:
of UTF-16 that did not support characters that had code points larger than
U+FFFF. In Node.js, these code points are always supported.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
Buffer.from('1ag123', 'hex');
@@ -206,9 +202,7 @@ Buffer.from('1a7', 'hex');
Buffer.from('1634', 'hex');
// Prints , all data represented.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
Buffer.from('1ag123', 'hex');
@@ -255,7 +249,7 @@ There are two ways to create new [`TypedArray`][] instances from a `Buffer`:
contents, interpreted as an array of integers, and not as a byte sequence
of the target type.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
@@ -264,9 +258,7 @@ const uint32array = new Uint32Array(buf);
console.log(uint32array);
// Prints: Uint32Array(4) [ 1, 2, 3, 4 ]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -280,7 +272,7 @@ console.log(uint32array);
* Passing the `Buffer`s underlying [`ArrayBuffer`][] will create a
[`TypedArray`][] that shares its memory with the `Buffer`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('hello', 'utf16le');
@@ -292,9 +284,7 @@ const uint16array = new Uint16Array(
console.log(uint16array);
// Prints: Uint16Array(5) [ 104, 101, 108, 108, 111 ]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('hello', 'utf16le');
@@ -313,7 +303,7 @@ 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.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arr = new Uint16Array(2);
@@ -338,9 +328,7 @@ console.log(buf1);
// Prints:
console.log(buf2);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(2);
@@ -371,7 +359,7 @@ 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
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arr = new Uint16Array(20);
@@ -379,9 +367,7 @@ const buf = Buffer.from(arr.buffer, 0, 16);
console.log(buf.length);
// Prints: 16
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(20);
@@ -410,7 +396,7 @@ function:
`Buffer` instances can be iterated over using `for..of` syntax:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3]);
@@ -422,9 +408,7 @@ for (const b of buf) {
// 1
// 2
// 3
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3]);
@@ -530,7 +514,7 @@ destinations without transferring or immediately copying the data. The data
contained by the `Blob` is copied only when the `arrayBuffer()` or `text()`
methods are called.
-```mjs
+```mjs|cjs
import { Blob, Buffer } from 'node:buffer';
import { setTimeout as delay } from 'node:timers/promises';
@@ -555,9 +539,7 @@ mc2.port2.postMessage(blob);
// The Blob is still usable after posting.
blob.text().then(console.log);
-```
-
-```cjs
+--------------
const { Blob, Buffer } = require('node:buffer');
const { setTimeout: delay } = require('node:timers/promises');
@@ -602,16 +584,14 @@ It can be constructed in a variety of ways.
Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the
`Buffer` will be zero-filled.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(5);
@@ -627,16 +607,14 @@ is thrown.
If `fill` is specified, the allocated `Buffer` will be initialized by calling
[`buf.fill(fill)`][`buf.fill()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5, 'a');
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(5, 'a');
@@ -648,16 +626,14 @@ console.log(buf);
If both `fill` and `encoding` are specified, the allocated `Buffer` will be
initialized by calling [`buf.fill(fill, encoding)`][`buf.fill()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
@@ -688,7 +664,7 @@ initialized_. The contents of the newly created `Buffer` are unknown and
_may contain sensitive data_. Use [`Buffer.alloc()`][] instead to initialize
`Buffer` instances with zeroes.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(10);
@@ -700,9 +676,7 @@ buf.fill(0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(10);
@@ -760,7 +734,7 @@ memory from a pool for an indeterminate amount of time, it may be appropriate
to create an un-pooled `Buffer` instance using `Buffer.allocUnsafeSlow()` and
then copying out the relevant bits.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Need to keep around a few small chunks of memory.
@@ -778,9 +752,7 @@ socket.on('readable', () => {
store.push(sb);
}
});
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Need to keep around a few small chunks of memory.
@@ -821,7 +793,7 @@ For strings that contain non-base64/hex-encoded data (e.g. whitespace), the
return value might be greater than the length of a `Buffer` created from the
string.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const str = '\u00bd + \u00bc = \u00be';
@@ -829,9 +801,7 @@ const str = '\u00bd + \u00bc = \u00be';
console.log(`${str}: ${str.length} characters, ` +
`${Buffer.byteLength(str, 'utf8')} bytes`);
// Prints: ½ + ¼ = ¾: 9 characters, 12 bytes
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const str = '\u00bd + \u00bc = \u00be';
@@ -858,7 +828,7 @@ Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of
`Buffer` instances. This is equivalent to calling
[`buf1.compare(buf2)`][`buf.compare()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('1234');
@@ -868,9 +838,7 @@ const arr = [buf1, buf2];
console.log(arr.sort(Buffer.compare));
// Prints: [ , ]
// (This result is equal to: [buf2, buf1].)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('1234');
@@ -905,7 +873,7 @@ If `totalLength` is provided, it is coerced to an unsigned integer. If the
combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is
truncated to `totalLength`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a single `Buffer` from a list of three `Buffer` instances.
@@ -924,9 +892,7 @@ console.log(bufA);
// Prints:
console.log(bufA.length);
// Prints: 42
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a single `Buffer` from a list of three `Buffer` instances.
@@ -950,6 +916,26 @@ console.log(bufA.length);
`Buffer.concat()` may also use the internal `Buffer` pool like
[`Buffer.allocUnsafe()`][] does.
+#### Static method: `Buffer.copyBytesFrom(view[, offset[, length]])`
+
+
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arr = new Uint16Array(2);
@@ -1040,7 +1022,7 @@ console.log(buf);
The optional `byteOffset` and `length` arguments specify a memory range within
the `arrayBuffer` that will be shared by the `Buffer`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const ab = new ArrayBuffer(10);
@@ -1048,9 +1030,7 @@ const buf = Buffer.from(ab, 0, 2);
console.log(buf.length);
// Prints: 2
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const ab = new ArrayBuffer(10);
@@ -1069,7 +1049,7 @@ of memory that extends beyond the bounds of a `TypedArray` view. A new
`Buffer` created using the `buffer` property of a `TypedArray` may extend
beyond the range of the `TypedArray`:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 elements
@@ -1079,9 +1059,7 @@ console.log(arrA.buffer === arrB.buffer); // true
const buf = Buffer.from(arrB.buffer);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 elements
@@ -1102,7 +1080,7 @@ console.log(buf);
Copies the passed `buffer` data onto a new `Buffer` instance.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('buffer');
@@ -1114,9 +1092,7 @@ console.log(buf1.toString());
// Prints: auffer
console.log(buf2.toString());
// Prints: buffer
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('buffer');
@@ -1144,14 +1120,12 @@ appropriate for `Buffer.from()` variants.
For objects whose `valueOf()` function returns a value not strictly equal to
`object`, returns `Buffer.from(object.valueOf(), offsetOrEncoding, length)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from(new String('this is a test'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from(new String('this is a test'));
@@ -1161,7 +1135,7 @@ const buf = Buffer.from(new String('this is a test'));
For objects that support `Symbol.toPrimitive`, returns
`Buffer.from(object[Symbol.toPrimitive]('string'), offsetOrEncoding)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
class Foo {
@@ -1172,9 +1146,7 @@ class Foo {
const buf = Buffer.from(new Foo(), 'utf8');
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
class Foo {
@@ -1200,7 +1172,7 @@ is not of another type appropriate for `Buffer.from()` variants.
Creates a new `Buffer` containing `string`. The `encoding` parameter identifies
the character encoding to be used when converting `string` into bytes.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('this is a tést');
@@ -1212,9 +1184,7 @@ console.log(buf2.toString());
// Prints: this is a tést
console.log(buf1.toString('latin1'));
// Prints: this is a tést
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('this is a tést');
@@ -1240,7 +1210,7 @@ appropriate for `Buffer.from()` variants.
Returns `true` if `obj` is a `Buffer`, `false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
Buffer.isBuffer(Buffer.alloc(10)); // true
@@ -1248,9 +1218,7 @@ Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
Buffer.isBuffer(Buffer.alloc(10)); // true
@@ -1270,7 +1238,7 @@ Buffer.isBuffer(new Uint8Array(1024)); // false
Returns `true` if `encoding` is the name of a supported character encoding,
or `false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
console.log(Buffer.isEncoding('utf8'));
@@ -1284,9 +1252,7 @@ console.log(Buffer.isEncoding('utf/8'));
console.log(Buffer.isEncoding(''));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
console.log(Buffer.isEncoding('utf8'));
@@ -1325,7 +1291,7 @@ access is the same as `Uint8Array`. In other words, `buf[index]` returns
`buf[index] = value` does not modify the buffer if `index` is negative or
`>= buf.length`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Copy an ASCII string into a `Buffer` one byte at a time.
@@ -1341,9 +1307,7 @@ for (let i = 0; i < str.length; i++) {
console.log(buf.toString('utf8'));
// Prints: Node.js
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Copy an ASCII string into a `Buffer` one byte at a time.
@@ -1369,7 +1333,7 @@ console.log(buf.toString('utf8'));
This `ArrayBuffer` is not guaranteed to correspond exactly to the original
`Buffer`. See the notes on `buf.byteOffset` for details.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const arrayBuffer = new ArrayBuffer(16);
@@ -1377,9 +1341,7 @@ const buffer = Buffer.from(arrayBuffer);
console.log(buffer.buffer === arrayBuffer);
// Prints: true
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const arrayBuffer = new ArrayBuffer(16);
@@ -1404,7 +1366,7 @@ to the `Buffer` object itself.
A common issue when creating a `TypedArray` object that shares its memory with
a `Buffer` is that in this case one needs to specify the `byteOffset` correctly:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a buffer smaller than `Buffer.poolSize`.
@@ -1414,9 +1376,7 @@ const nodeBuffer = Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
// to refer only to the part of `nodeBuffer.buffer` that contains the memory
// for `nodeBuffer`.
new Int8Array(nodeBuffer.buffer, nodeBuffer.byteOffset, nodeBuffer.length);
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a buffer smaller than `Buffer.poolSize`.
@@ -1452,7 +1412,7 @@ Comparison is based on the actual sequence of bytes in each `Buffer`.
* `1` is returned if `target` should come _before_ `buf` when sorted.
* `-1` is returned if `target` should come _after_ `buf` when sorted.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
@@ -1472,9 +1432,7 @@ console.log(buf2.compare(buf3));
console.log([buf1, buf2, buf3].sort(Buffer.compare));
// Prints: [ , , ]
// (This result is equal to: [buf1, buf3, buf2].)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('ABC');
@@ -1500,7 +1458,7 @@ The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`
arguments can be used to limit the comparison to specific ranges within `target`
and `buf` respectively.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
@@ -1512,9 +1470,7 @@ console.log(buf1.compare(buf2, 0, 6, 4));
// Prints: -1
console.log(buf1.compare(buf2, 5, 6, 5));
// Prints: 1
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
@@ -1551,7 +1507,7 @@ memory region overlaps with `buf`.
for all TypedArrays, including Node.js `Buffer`s, although it takes
different function arguments.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create two `Buffer` instances.
@@ -1570,9 +1526,7 @@ buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create two `Buffer` instances.
@@ -1593,7 +1547,7 @@ console.log(buf2.toString('ascii', 0, 25));
// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
```
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` and copy data from one region to an overlapping region
@@ -1610,9 +1564,7 @@ buf.copy(buf, 0, 4, 10);
console.log(buf.toString());
// Prints: efghijghijklmnopqrstuvwxyz
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` and copy data from one region to an overlapping region
@@ -1640,7 +1592,7 @@ console.log(buf.toString());
Creates and returns an [iterator][] of `[index, byte]` pairs from the contents
of `buf`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Log the entire contents of a `Buffer`.
@@ -1657,9 +1609,7 @@ for (const pair of buf.entries()) {
// [3, 102]
// [4, 101]
// [5, 114]
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Log the entire contents of a `Buffer`.
@@ -1690,7 +1640,7 @@ Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,
`false` otherwise. Equivalent to
[`buf.compare(otherBuffer) === 0`][`buf.compare()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
@@ -1701,9 +1651,7 @@ console.log(buf1.equals(buf2));
// Prints: true
console.log(buf1.equals(buf3));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from('ABC');
@@ -1733,7 +1681,7 @@ console.log(buf1.equals(buf3));
Fills `buf` with the specified `value`. If the `offset` and `end` are not given,
the entire `buf` will be filled:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with the ASCII character 'h'.
@@ -1748,9 +1696,7 @@ const c = Buffer.allocUnsafe(5).fill('');
console.log(c.fill(''));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Fill a `Buffer` with the ASCII character 'h'.
@@ -1774,16 +1720,14 @@ filled with `value & 255`.
If the final write of a `fill()` operation falls on a multi-byte character,
then only the bytes of that character that fit into `buf` are written:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with character that takes up two bytes in UTF-8.
console.log(Buffer.allocUnsafe(5).fill('\u0222'));
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Fill a `Buffer` with character that takes up two bytes in UTF-8.
@@ -1795,7 +1739,7 @@ console.log(Buffer.allocUnsafe(5).fill('\u0222'));
If `value` contains invalid characters, it is truncated; if no valid
fill data remains, an exception is thrown:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(5);
@@ -1806,9 +1750,7 @@ console.log(buf.fill('aazz', 'hex'));
// Prints:
console.log(buf.fill('zz', 'hex'));
// Throws an exception.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(5);
@@ -1834,7 +1776,7 @@ console.log(buf.fill('zz', 'hex'));
Equivalent to [`buf.indexOf() !== -1`][`buf.indexOf()`].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
@@ -1853,9 +1795,7 @@ console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: true
console.log(buf.includes('this', 4));
// Prints: false
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this is a buffer');
@@ -1898,7 +1838,7 @@ If `value` is:
* a number, `value` will be interpreted as an unsigned 8-bit integer
value between `0` and `255`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
@@ -1922,9 +1862,7 @@ console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
// Prints: 4
console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
// Prints: 6
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this is a buffer');
@@ -1958,7 +1896,7 @@ If `byteOffset` is not a number, it will be coerced to a number. If the result
of coercion is `NaN` or `0`, then the entire buffer will be searched. This
behavior matches [`String.prototype.indexOf()`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const b = Buffer.from('abcdef');
@@ -1974,9 +1912,7 @@ console.log(b.indexOf('b', undefined));
console.log(b.indexOf('b', {}));
console.log(b.indexOf('b', null));
console.log(b.indexOf('b', []));
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const b = Buffer.from('abcdef');
@@ -2006,7 +1942,7 @@ than `buf.length`, `byteOffset` will be returned. If `value` is empty and
Creates and returns an [iterator][] of `buf` keys (indices).
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -2021,9 +1957,7 @@ for (const key of buf.keys()) {
// 3
// 4
// 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -2057,7 +1991,7 @@ for (const key of buf.keys()) {
Identical to [`buf.indexOf()`][], except the last occurrence of `value` is found
rather than the first occurrence.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this buffer is a buffer');
@@ -2083,9 +2017,7 @@ console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// Prints: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// Prints: 4
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('this buffer is a buffer');
@@ -2121,7 +2053,7 @@ If `byteOffset` is not a number, it will be coerced to a number. Any arguments
that coerce to `NaN`, like `{}` or `undefined`, will search the whole buffer.
This behavior matches [`String.prototype.lastIndexOf()`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const b = Buffer.from('abcdef');
@@ -2140,9 +2072,7 @@ console.log(b.lastIndexOf('b', {}));
// Prints: -1, equivalent to passing 0.
console.log(b.lastIndexOf('b', null));
console.log(b.lastIndexOf('b', []));
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const b = Buffer.from('abcdef');
@@ -2173,7 +2103,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
Returns the number of bytes in `buf`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` and write a shorter string to it using UTF-8.
@@ -2187,9 +2117,7 @@ buf.write('some string', 0, 'utf8');
console.log(buf.length);
// Prints: 1234
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` and write a shorter string to it using UTF-8.
@@ -2257,16 +2185,14 @@ Reads an unsigned, big-endian 64-bit integer from `buf` at the specified
This function is also available under the `readBigUint64BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64BE(0));
// Prints: 4294967295n
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
@@ -2288,16 +2214,14 @@ Reads an unsigned, little-endian 64-bit integer from `buf` at the specified
This function is also available under the `readBigUint64LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64LE(0));
// Prints: 18446744069414584320n
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
@@ -2316,16 +2240,14 @@ console.log(buf.readBigUInt64LE(0));
Reads a 64-bit, big-endian double from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleBE(0));
// Prints: 8.20788039913184e-304
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2344,7 +2266,7 @@ console.log(buf.readDoubleBE(0));
Reads a 64-bit, little-endian double from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2353,9 +2275,7 @@ console.log(buf.readDoubleLE(0));
// Prints: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
@@ -2376,16 +2296,14 @@ console.log(buf.readDoubleLE(1));
Reads a 32-bit, big-endian float from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatBE(0));
// Prints: 2.387939260590663e-38
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2404,7 +2322,7 @@ console.log(buf.readFloatBE(0));
Reads a 32-bit, little-endian float from `buf` at the specified `offset`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2413,9 +2331,7 @@ console.log(buf.readFloatLE(0));
// Prints: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, 2, 3, 4]);
@@ -2438,7 +2354,7 @@ Reads a signed 8-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([-1, 5]);
@@ -2449,9 +2365,7 @@ console.log(buf.readInt8(1));
// Prints: 5
console.log(buf.readInt8(2));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([-1, 5]);
@@ -2476,16 +2390,14 @@ Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16BE(0));
// Prints: 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 5]);
@@ -2507,7 +2419,7 @@ Reads a signed, little-endian 16-bit integer from `buf` at the specified
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
@@ -2516,9 +2428,7 @@ console.log(buf.readInt16LE(0));
// Prints: 1280
console.log(buf.readInt16LE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 5]);
@@ -2541,16 +2451,14 @@ Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32BE(0));
// Prints: 5
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2572,7 +2480,7 @@ Reads a signed, little-endian 32-bit integer from `buf` at the specified
Integers read from a `Buffer` are interpreted as two's complement signed values.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2581,9 +2489,7 @@ console.log(buf.readInt32LE(0));
// Prints: 83886080
console.log(buf.readInt32LE(1));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0, 0, 0, 5]);
@@ -2608,7 +2514,7 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as a big-endian, two's complement signed value
supporting up to 48 bits of accuracy.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2619,9 +2525,7 @@ console.log(buf.readIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
console.log(buf.readIntBE(1, 0).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2648,16 +2552,14 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as a little-endian, two's complement signed value
supporting up to 48 bits of accuracy.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntLE(0, 6).toString(16));
// Prints: -546f87a9cbee
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2678,7 +2580,7 @@ Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
This function is also available under the `readUint8` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, -2]);
@@ -2689,9 +2591,7 @@ console.log(buf.readUInt8(1));
// Prints: 254
console.log(buf.readUInt8(2));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([1, -2]);
@@ -2717,7 +2617,7 @@ Reads an unsigned, big-endian 16-bit integer from `buf` at the specified
This function is also available under the `readUint16BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2726,9 +2626,7 @@ console.log(buf.readUInt16BE(0).toString(16));
// Prints: 1234
console.log(buf.readUInt16BE(1).toString(16));
// Prints: 3456
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2752,7 +2650,7 @@ Reads an unsigned, little-endian 16-bit integer from `buf` at the specified
This function is also available under the `readUint16LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2763,9 +2661,7 @@ console.log(buf.readUInt16LE(1).toString(16));
// Prints: 5634
console.log(buf.readUInt16LE(2).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56]);
@@ -2791,16 +2687,14 @@ Reads an unsigned, big-endian 32-bit integer from `buf` at the specified
This function is also available under the `readUint32BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32BE(0).toString(16));
// Prints: 12345678
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2822,7 +2716,7 @@ Reads an unsigned, little-endian 32-bit integer from `buf` at the specified
This function is also available under the `readUint32LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2831,9 +2725,7 @@ console.log(buf.readUInt32LE(0).toString(16));
// Prints: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
@@ -2860,7 +2752,7 @@ up to 48 bits of accuracy.
This function is also available under the `readUintBE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2869,9 +2761,7 @@ console.log(buf.readUIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2898,16 +2788,14 @@ up to 48 bits of accuracy.
This function is also available under the `readUintLE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntLE(0, 6).toString(16));
// Prints: ab9078563412
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
@@ -2936,7 +2824,7 @@ This method is inherited from [`TypedArray.prototype.subarray()`][].
Modifying the new `Buffer` slice will modify the memory in the original `Buffer`
because the allocated memory of the two objects overlap.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
// Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
@@ -2958,9 +2846,7 @@ buf1[0] = 33;
console.log(buf2.toString('ascii', 0, buf2.length));
// Prints: !bc
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
// Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
@@ -2987,7 +2873,7 @@ console.log(buf2.toString('ascii', 0, buf2.length));
Specifying negative indexes causes the slice to be generated relative to the
end of `buf` rather than the beginning.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3003,9 +2889,7 @@ console.log(buf.subarray(-6, -2).toString());
console.log(buf.subarray(-5, -2).toString());
// Prints: uff
// (Equivalent to buf.subarray(1, 4).)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3045,7 +2929,7 @@ This method is not compatible with the `Uint8Array.prototype.slice()`,
which is a superclass of `Buffer`. To copy the slice, use
`Uint8Array.prototype.slice()`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3065,9 +2949,7 @@ console.log(notReallyCopiedBuf.toString());
// Prints: cuffer
console.log(buf.toString());
// Also prints: cuffer (!)
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3099,7 +2981,7 @@ Interprets `buf` as an array of unsigned 16-bit integers and swaps the
byte order _in-place_. Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][]
is not a multiple of 2.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3116,9 +2998,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap16();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3140,14 +3020,12 @@ buf2.swap16();
One convenient use of `buf.swap16()` is to perform a fast in-place conversion
between UTF-16 little-endian and UTF-16 big-endian:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
buf.swap16(); // Convert to big-endian UTF-16 text.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
@@ -3164,7 +3042,7 @@ Interprets `buf` as an array of unsigned 32-bit integers and swaps the
byte order _in-place_. Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][]
is not a multiple of 4.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3181,9 +3059,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap32();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3211,7 +3087,7 @@ buf2.swap32();
Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_.
Throws [`ERR_INVALID_BUFFER_SIZE`][] if [`buf.length`][] is not a multiple of 8.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3228,9 +3104,7 @@ const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
@@ -3261,7 +3135,7 @@ this function when stringifying a `Buffer` instance.
`Buffer.from()` accepts objects in the format returned from this method.
In particular, `Buffer.from(buf.toJSON())` works like `Buffer.from(buf)`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
@@ -3278,9 +3152,7 @@ const copy = JSON.parse(json, (key, value) => {
console.log(copy);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
@@ -3318,7 +3190,7 @@ then each invalid byte 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`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf1 = Buffer.allocUnsafe(26);
@@ -3341,9 +3213,7 @@ console.log(buf2.toString('utf8', 0, 3));
// Prints: té
console.log(buf2.toString(undefined, 0, 3));
// Prints: té
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf1 = Buffer.allocUnsafe(26);
@@ -3377,7 +3247,7 @@ console.log(buf2.toString(undefined, 0, 3));
Creates and returns an [iterator][] for `buf` values (bytes). This function is
called automatically when a `Buffer` is used in a `for..of` statement.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
@@ -3403,9 +3273,7 @@ for (const value of buf) {
// 102
// 101
// 114
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.from('buffer');
@@ -3450,7 +3318,7 @@ Writes `string` to `buf` at `offset` according to the character encoding in
not contain enough space to fit the entire string, only part of `string` will be
written. However, partially encoded characters will not be written.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(256);
@@ -3466,9 +3334,7 @@ const length = buffer.write('abcd', 8);
console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// Prints: 2 bytes : ab
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.alloc(256);
@@ -3499,7 +3365,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3508,9 +3374,7 @@ buf.writeBigInt64BE(0x0102030405060708n, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3534,7 +3398,7 @@ Writes `value` to `buf` at the specified `offset` as little-endian.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3543,9 +3407,7 @@ buf.writeBigInt64LE(0x0102030405060708n, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3569,7 +3431,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian.
This function is also available under the `writeBigUint64BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3578,9 +3440,7 @@ buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3602,7 +3462,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as little-endian
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3611,9 +3471,7 @@ buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3639,7 +3497,7 @@ Writes `value` to `buf` at the specified `offset` as big-endian. The `value`
must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3648,9 +3506,7 @@ buf.writeDoubleBE(123.456, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3674,7 +3530,7 @@ Writes `value` to `buf` at the specified `offset` as little-endian. The `value`
must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
@@ -3683,9 +3539,7 @@ buf.writeDoubleLE(123.456, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(8);
@@ -3708,7 +3562,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3717,9 +3571,7 @@ buf.writeFloatBE(0xcafebabe, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3742,7 +3594,7 @@ console.log(buf);
Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3751,9 +3603,7 @@ buf.writeFloatLE(0xcafebabe, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3779,7 +3629,7 @@ a signed 8-bit integer.
`value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3789,9 +3639,7 @@ buf.writeInt8(-2, 1);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3818,7 +3666,7 @@ anything other than a signed 16-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3827,9 +3675,7 @@ buf.writeInt16BE(0x0102, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3855,7 +3701,7 @@ anything other than a signed 16-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
@@ -3864,9 +3710,7 @@ buf.writeInt16LE(0x0304, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(2);
@@ -3892,7 +3736,7 @@ anything other than a signed 32-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3901,9 +3745,7 @@ buf.writeInt32BE(0x01020304, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3929,7 +3771,7 @@ anything other than a signed 32-bit integer.
The `value` is interpreted and written as a two's complement signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -3938,9 +3780,7 @@ buf.writeInt32LE(0x05060708, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -3966,7 +3806,7 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when
`value` is anything other than a signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -3975,9 +3815,7 @@ buf.writeIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4003,7 +3841,7 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than a signed integer.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4012,9 +3850,7 @@ buf.writeIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4040,7 +3876,7 @@ other than an unsigned 8-bit integer.
This function is also available under the `writeUint8` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4052,9 +3888,7 @@ buf.writeUInt8(0x42, 3);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4083,7 +3917,7 @@ is anything other than an unsigned 16-bit integer.
This function is also available under the `writeUint16BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4093,9 +3927,7 @@ buf.writeUInt16BE(0xbeef, 2);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4122,7 +3954,7 @@ anything other than an unsigned 16-bit integer.
This function is also available under the `writeUint16LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4132,9 +3964,7 @@ buf.writeUInt16LE(0xbeef, 2);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4161,7 +3991,7 @@ is anything other than an unsigned 32-bit integer.
This function is also available under the `writeUint32BE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4170,9 +4000,7 @@ buf.writeUInt32BE(0xfeedface, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4198,7 +4026,7 @@ anything other than an unsigned 32-bit integer.
This function is also available under the `writeUint32LE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
@@ -4207,9 +4035,7 @@ buf.writeUInt32LE(0xfeedface, 0);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(4);
@@ -4237,7 +4063,7 @@ when `value` is anything other than an unsigned integer.
This function is also available under the `writeUintBE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4246,9 +4072,7 @@ buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4276,7 +4100,7 @@ when `value` is anything other than an unsigned integer.
This function is also available under the `writeUintLE` alias.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
@@ -4285,9 +4109,7 @@ buf.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints:
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const buf = Buffer.allocUnsafe(6);
@@ -4564,15 +4386,13 @@ Encodings supported by `buffer.transcode()` are: `'ascii'`, `'utf8'`,
The transcoding process will use substitution characters if a given byte
sequence cannot be adequately represented in the target encoding. For instance:
-```mjs
+```mjs|cjs
import { Buffer, transcode } from 'node:buffer';
const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
console.log(newBuf.toString('ascii'));
// Prints: '?'
-```
-
-```cjs
+--------------
const { Buffer, transcode } = require('node:buffer');
const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
diff --git a/content/api/v19/child_process.en.md b/content/api/v19/child_process.en.md
index cff9fb0e4d..e26a4b845d 100644
--- a/content/api/v19/child_process.en.md
+++ b/content/api/v19/child_process.en.md
@@ -13,7 +13,7 @@ Stable
-
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const spkac = getSpkacSomehow();
const publicKey = Certificate.exportPublicKey(spkac);
@@ -151,18 +145,16 @@ console.log(publicKey);
* Returns: [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) `true` if the given `spkac` data structure is valid,
`false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { Certificate } = await import('node:crypto');
const spkac = getSpkacSomehow();
console.log(Certificate.verifySpkac(Buffer.from(spkac)));
// Prints: true or false
-```
-
-```cjs
-const { Certificate } = require('node:crypto');
+--------------
const { Buffer } = require('node:buffer');
+const { Certificate } = require('node:crypto');
const spkac = getSpkacSomehow();
console.log(Certificate.verifySpkac(Buffer.from(spkac)));
@@ -185,14 +177,12 @@ the `crypto.Certificate` class as illustrated in the examples below.
Instances of the `Certificate` class can be created using the `new` keyword
or by calling `crypto.Certificate()` as a function:
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert1 = new Certificate();
const cert2 = Certificate();
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert1 = new Certificate();
@@ -208,16 +198,14 @@ const cert2 = Certificate();
* Returns: [`Buffer`](/api/v19/buffer#buffer) The challenge component of the `spkac` data structure, which
includes a public key and a challenge.
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
const challenge = cert.exportChallenge(spkac);
console.log(challenge.toString('utf8'));
// Prints: the challenge as a UTF8 string
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -235,16 +223,14 @@ console.log(challenge.toString('utf8'));
* Returns: [`Buffer`](/api/v19/buffer#buffer) The public key component of the `spkac` data structure,
which includes a public key and a challenge.
-```mjs
+```mjs|cjs
const { Certificate } = await import('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
const publicKey = cert.exportPublicKey(spkac);
console.log(publicKey);
// Prints: the public key as
-```
-
-```cjs
+--------------
const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -262,7 +248,7 @@ console.log(publicKey);
* Returns: [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) `true` if the given `spkac` data structure is valid,
`false` otherwise.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { Certificate } = await import('node:crypto');
@@ -270,11 +256,9 @@ const cert = Certificate();
const spkac = getSpkacSomehow();
console.log(cert.verifySpkac(Buffer.from(spkac)));
// Prints: true or false
-```
-
-```cjs
-const { Certificate } = require('node:crypto');
+--------------
const { Buffer } = require('node:buffer');
+const { Certificate } = require('node:crypto');
const cert = Certificate();
const spkac = getSpkacSomehow();
@@ -302,7 +286,7 @@ directly using the `new` keyword.
Example: Using `Cipher` objects as streams:
-```mjs
+```mjs|cjs
const {
scrypt,
randomFill,
@@ -333,9 +317,7 @@ scrypt(password, 'salt', 24, (err, key) => {
cipher.end();
});
});
-```
-
-```cjs
+--------------
const {
scrypt,
randomFill,
@@ -370,7 +352,7 @@ scrypt(password, 'salt', 24, (err, key) => {
Example: Using `Cipher` and piped streams:
-```mjs
+```mjs|cjs
import {
createReadStream,
createWriteStream,
@@ -407,9 +389,7 @@ scrypt(password, 'salt', 24, (err, key) => {
});
});
});
-```
-
-```cjs
+--------------
const {
createReadStream,
createWriteStream,
@@ -450,7 +430,7 @@ scrypt(password, 'salt', 24, (err, key) => {
Example: Using the [`cipher.update()`][] and [`cipher.final()`][] methods:
-```mjs
+```mjs|cjs
const {
scrypt,
randomFill,
@@ -475,9 +455,7 @@ scrypt(password, 'salt', 24, (err, key) => {
console.log(encrypted);
});
});
-```
-
-```cjs
+--------------
const {
scrypt,
randomFill,
@@ -618,7 +596,7 @@ directly using the `new` keyword.
Example: Using `Decipher` objects as streams:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
scryptSync,
@@ -653,9 +631,7 @@ const encrypted =
'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';
decipher.write(encrypted, 'hex');
decipher.end();
-```
-
-```cjs
+--------------
const {
scryptSync,
createDecipheriv,
@@ -694,7 +670,7 @@ decipher.end();
Example: Using `Decipher` and piped streams:
-```mjs
+```mjs|cjs
import {
createReadStream,
createWriteStream,
@@ -718,9 +694,7 @@ const input = createReadStream('test.enc');
const output = createWriteStream('test.js');
input.pipe(decipher).pipe(output);
-```
-
-```cjs
+--------------
const {
createReadStream,
createWriteStream,
@@ -748,7 +722,7 @@ input.pipe(decipher).pipe(output);
Example: Using the [`decipher.update()`][] and [`decipher.final()`][] methods:
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
scryptSync,
@@ -771,9 +745,7 @@ let decrypted = decipher.update(encrypted, 'hex', 'utf8');
decrypted += decipher.final('utf8');
console.log(decrypted);
// Prints: some clear text data
-```
-
-```cjs
+--------------
const {
scryptSync,
createDecipheriv,
@@ -911,7 +883,7 @@ exchanges.
Instances of the `DiffieHellman` class can be created using the
[`crypto.createDiffieHellman()`][] function.
-```mjs
+```mjs|cjs
import assert from 'node:assert';
const {
@@ -932,9 +904,7 @@ const bobSecret = bob.computeSecret(aliceKey);
// OK
assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
-```
-
-```cjs
+--------------
const assert = require('node:assert');
const {
@@ -1081,12 +1051,10 @@ It works the same as `DiffieHellman`, except that it does not allow changing
its keys after creation. In other words, it does not implement `setPublicKey()`
or `setPrivateKey()` methods.
-```mjs
+```mjs|cjs
const { createDiffieHellmanGroup } = await import('node:crypto');
const dh = createDiffieHellmanGroup('modp16');
-```
-
-```cjs
+--------------
const { createDiffieHellmanGroup } = require('node:crypto');
const dh = createDiffieHellmanGroup('modp16');
```
@@ -1117,7 +1085,7 @@ key exchanges.
Instances of the `ECDH` class can be created using the
[`crypto.createECDH()`][] function.
-```mjs
+```mjs|cjs
import assert from 'node:assert';
const {
@@ -1138,9 +1106,7 @@ const bobSecret = bob.computeSecret(aliceKey);
assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
// OK
-```
-
-```cjs
+--------------
const assert = require('node:assert');
const {
@@ -1192,7 +1158,7 @@ If the `inputEncoding` is not provided, `key` is expected to be a [`Buffer`][],
Example (uncompressing a key):
-```mjs
+```mjs|cjs
const {
createECDH,
ECDH,
@@ -1211,9 +1177,7 @@ const uncompressedKey = ECDH.convertKey(compressedKey,
// The converted key and the uncompressed public key should be the same
console.log(uncompressedKey === ecdh.getPublicKey('hex'));
-```
-
-```cjs
+--------------
const {
createECDH,
ECDH,
@@ -1347,7 +1311,7 @@ set.
Example (obtaining a shared secret):
-```mjs
+```mjs|cjs
const {
createECDH,
createHash,
@@ -1372,9 +1336,7 @@ const bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex');
// aliceSecret and bobSecret should be the same shared secret value
console.log(aliceSecret === bobSecret);
-```
-
-```cjs
+--------------
const {
createECDH,
createHash,
@@ -1420,7 +1382,7 @@ objects are not to be created directly using the `new` keyword.
Example: Using `Hash` objects as streams:
-```mjs
+```mjs|cjs
const {
createHash,
} = await import('node:crypto');
@@ -1440,9 +1402,7 @@ hash.on('readable', () => {
hash.write('some data to hash');
hash.end();
-```
-
-```cjs
+--------------
const {
createHash,
} = require('node:crypto');
@@ -1466,7 +1426,7 @@ hash.end();
Example: Using `Hash` and piped streams:
-```mjs
+```mjs|cjs
import { createReadStream } from 'node:fs';
import { stdout } from 'node:process';
const { createHash } = await import('node:crypto');
@@ -1475,9 +1435,7 @@ const hash = createHash('sha256');
const input = createReadStream('test.js');
input.pipe(hash).setEncoding('hex').pipe(stdout);
-```
-
-```cjs
+--------------
const { createReadStream } = require('node:fs');
const { createHash } = require('node:crypto');
const { stdout } = require('node:process');
@@ -1490,7 +1448,7 @@ input.pipe(hash).setEncoding('hex').pipe(stdout);
Example: Using the [`hash.update()`][] and [`hash.digest()`][] methods:
-```mjs
+```mjs|cjs
const {
createHash,
} = await import('node:crypto');
@@ -1501,9 +1459,7 @@ hash.update('some data to hash');
console.log(hash.digest('hex'));
// Prints:
// 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50
-```
-
-```cjs
+--------------
const {
createHash,
} = require('node:crypto');
@@ -1533,7 +1489,7 @@ specify the desired output length in bytes.
An error is thrown when an attempt is made to copy the `Hash` object after
its [`hash.digest()`][] method has been called.
-```mjs
+```mjs|cjs
// Calculate a rolling hash.
const {
createHash,
@@ -1551,9 +1507,7 @@ hash.update('three');
console.log(hash.copy().digest('hex'));
// Etc.
-```
-
-```cjs
+--------------
// Calculate a rolling hash.
const {
createHash,
@@ -1622,7 +1576,7 @@ objects are not to be created directly using the `new` keyword.
Example: Using `Hmac` objects as streams:
-```mjs
+```mjs|cjs
const {
createHmac,
} = await import('node:crypto');
@@ -1642,9 +1596,7 @@ hmac.on('readable', () => {
hmac.write('some data to hash');
hmac.end();
-```
-
-```cjs
+--------------
const {
createHmac,
} = require('node:crypto');
@@ -1668,7 +1620,7 @@ hmac.end();
Example: Using `Hmac` and piped streams:
-```mjs
+```mjs|cjs
import { createReadStream } from 'node:fs';
import { stdout } from 'node:process';
const {
@@ -1679,9 +1631,7 @@ const hmac = createHmac('sha256', 'a secret');
const input = createReadStream('test.js');
input.pipe(hmac).pipe(stdout);
-```
-
-```cjs
+--------------
const {
createReadStream,
} = require('node:fs');
@@ -1698,7 +1648,7 @@ input.pipe(hmac).pipe(stdout);
Example: Using the [`hmac.update()`][] and [`hmac.digest()`][] methods:
-```mjs
+```mjs|cjs
const {
createHmac,
} = await import('node:crypto');
@@ -1709,9 +1659,7 @@ hmac.update('some data to hash');
console.log(hmac.digest('hex'));
// Prints:
// 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e
-```
-
-```cjs
+--------------
const {
createHmac,
} = require('node:crypto');
@@ -1780,7 +1728,7 @@ be listed in the `transferList` argument.
Example: Converting a `CryptoKey` instance to a `KeyObject`:
-```mjs
+```mjs|cjs
const { KeyObject } = await import('node:crypto');
const { subtle } = globalThis.crypto;
@@ -1793,9 +1741,7 @@ const key = await subtle.generateKey({
const keyObject = KeyObject.from(key);
console.log(keyObject.symmetricKeySize);
// Prints: 32 (symmetric key size in bytes)
-```
-
-```cjs
+--------------
const { KeyObject } = require('node:crypto');
const { subtle } = globalThis.crypto;
@@ -1954,7 +1900,7 @@ to be created directly using the `new` keyword.
Example: Using `Sign` and [`Verify`][] objects as streams:
-```mjs
+```mjs|cjs
const {
generateKeyPairSync,
createSign,
@@ -1975,9 +1921,7 @@ verify.write('some data to sign');
verify.end();
console.log(verify.verify(publicKey, signature, 'hex'));
// Prints: true
-```
-
-```cjs
+--------------
const {
generateKeyPairSync,
createSign,
@@ -2002,7 +1946,7 @@ console.log(verify.verify(publicKey, signature, 'hex'));
Example: Using the [`sign.update()`][] and [`verify.update()`][] methods:
-```mjs
+```mjs|cjs
const {
generateKeyPairSync,
createSign,
@@ -2023,9 +1967,7 @@ verify.update('some data to sign');
verify.end();
console.log(verify.verify(publicKey, signature));
// Prints: true
-```
-
-```cjs
+--------------
const {
generateKeyPairSync,
createSign,
@@ -2198,15 +2140,13 @@ be passed instead of a public key.
Encapsulates an X509 certificate and provides read-only access to
its information.
-```mjs
+```mjs|cjs
const { X509Certificate } = await import('node:crypto');
const x509 = new X509Certificate('{... pem encoded cert ...}');
console.log(x509.subject);
-```
-
-```cjs
+--------------
const { X509Certificate } = require('node:crypto');
const x509 = new X509Certificate('{... pem encoded cert ...}');
@@ -2852,7 +2792,7 @@ display the available digest algorithms.
Example: generating the sha256 sum of a file
-```mjs
+```mjs|cjs
import {
createReadStream,
} from 'node:fs';
@@ -2876,9 +2816,7 @@ input.on('readable', () => {
console.log(`${hash.digest('hex')} ${filename}`);
}
});
-```
-
-```cjs
+--------------
const {
createReadStream,
} = require('node:fs');
@@ -2927,7 +2865,7 @@ a [`KeyObject`][], its type must be `secret`.
Example: generating the sha256 HMAC of a file
-```mjs
+```mjs|cjs
import {
createReadStream,
} from 'node:fs';
@@ -2951,9 +2889,7 @@ input.on('readable', () => {
console.log(`${hmac.digest('hex')} ${filename}`);
}
});
-```
-
-```cjs
+--------------
const {
createReadStream,
} = require('node:fs');
@@ -3111,7 +3047,7 @@ Both keys must have the same `asymmetricKeyType`, which must be one of `'dh'`
Asynchronously generates a new random secret key of the given `length`. The
`type` will determine which validations will be performed on the `length`.
-```mjs
+```mjs|cjs
const {
generateKey,
} = await import('node:crypto');
@@ -3120,9 +3056,7 @@ generateKey('hmac', { length: 64 }, (err, key) => {
if (err) throw err;
console.log(key.export().toString('hex')); // 46e..........620
});
-```
-
-```cjs
+--------------
const {
generateKey,
} = require('node:crypto');
@@ -3172,7 +3106,7 @@ the respective part of the key is returned as a [`KeyObject`][].
It is recommended to encode public keys as `'spki'` and private keys as
`'pkcs8'` with encryption for long-term storage:
-```mjs
+```mjs|cjs
const {
generateKeyPair,
} = await import('node:crypto');
@@ -3192,9 +3126,7 @@ generateKeyPair('rsa', {
}, (err, publicKey, privateKey) => {
// Handle errors and use the generated key pair.
});
-```
-
-```cjs
+--------------
const {
generateKeyPair,
} = require('node:crypto');
@@ -3261,7 +3193,7 @@ When encoding public keys, it is recommended to use `'spki'`. When encoding
private keys, it is recommended to use `'pkcs8'` with a strong passphrase,
and to keep the passphrase confidential.
-```mjs
+```mjs|cjs
const {
generateKeyPairSync,
} = await import('node:crypto');
@@ -3282,9 +3214,7 @@ const {
passphrase: 'top secret',
},
});
-```
-
-```cjs
+--------------
const {
generateKeyPairSync,
} = require('node:crypto');
@@ -3328,16 +3258,14 @@ it will be a buffer containing the data encoded as DER.
Synchronously generates a new random secret key of the given `length`. The
`type` will determine which validations will be performed on the `length`.
-```mjs
+```mjs|cjs
const {
generateKeySync,
} = await import('node:crypto');
const key = generateKeySync('hmac', { length: 64 });
console.log(key.export().toString('hex')); // e89..........41e
-```
-
-```cjs
+--------------
const {
generateKeySync,
} = require('node:crypto');
@@ -3461,15 +3389,13 @@ unacceptable, `undefined` will be returned.
* Returns: string\[] An array with the names of the supported cipher
algorithms.
-```mjs
+```mjs|cjs
const {
getCiphers,
} = await import('node:crypto');
console.log(getCiphers()); // ['aes-128-cbc', 'aes-128-ccm', ...]
-```
-
-```cjs
+--------------
const {
getCiphers,
} = require('node:crypto');
@@ -3483,15 +3409,13 @@ console.log(getCiphers()); // ['aes-128-cbc', 'aes-128-ccm', ...]
* Returns: string\[] An array with the names of the supported elliptic curves.
-```mjs
+```mjs|cjs
const {
getCurves,
} = await import('node:crypto');
console.log(getCurves()); // ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...]
-```
-
-```cjs
+--------------
const {
getCurves,
} = require('node:crypto');
@@ -3518,7 +3442,7 @@ and communication time.
Example (obtaining a shared secret):
-```mjs
+```mjs|cjs
const {
getDiffieHellman,
} = await import('node:crypto');
@@ -3533,9 +3457,7 @@ const bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex');
/* aliceSecret and bobSecret should be the same */
console.log(aliceSecret === bobSecret);
-```
-
-```cjs
+--------------
const {
getDiffieHellman,
} = require('node:crypto');
@@ -3568,15 +3490,13 @@ console.log(aliceSecret === bobSecret);
* Returns: string\[] An array of the names of the supported hash algorithms,
such as `'RSA-SHA256'`. Hash algorithms are also called "digest" algorithms.
-```mjs
+```mjs|cjs
const {
getHashes,
} = await import('node:crypto');
console.log(getHashes()); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]
-```
-
-```cjs
+--------------
const {
getHashes,
} = require('node:crypto');
@@ -3623,7 +3543,7 @@ otherwise `err` will be `null`. The successfully generated `derivedKey` will
be passed to the callback as an [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). An error will be thrown if any
of the input arguments specify invalid values or types.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
hkdf,
@@ -3633,9 +3553,7 @@ hkdf('sha512', 'key', 'salt', 'info', 64, (err, derivedKey) => {
if (err) throw err;
console.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653'
});
-```
-
-```cjs
+--------------
const {
hkdf,
} = require('node:crypto');
@@ -3673,7 +3591,7 @@ The successfully generated `derivedKey` will be returned as an [`ArrayBuffer`](h
An error will be thrown if any of the input arguments specify invalid values or
types, or if the derived key cannot be generated.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
hkdfSync,
@@ -3681,9 +3599,7 @@ const {
const derivedKey = hkdfSync('sha512', 'key', 'salt', 'info', 64);
console.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653'
-```
-
-```cjs
+--------------
const {
hkdfSync,
} = require('node:crypto');
@@ -3727,7 +3643,7 @@ random and at least 16 bytes long. See [NIST SP 800-132][] for details.
When passing strings for `password` or `salt`, please consider
[caveats when using strings as inputs to cryptographic APIs][].
-```mjs
+```mjs|cjs
const {
pbkdf2,
} = await import('node:crypto');
@@ -3736,9 +3652,7 @@ pbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => {
if (err) throw err;
console.log(derivedKey.toString('hex')); // '3745e48...08d59ae'
});
-```
-
-```cjs
+--------------
const {
pbkdf2,
} = require('node:crypto');
@@ -3753,16 +3667,14 @@ The `crypto.DEFAULT_ENCODING` property can be used to change the way the
`derivedKey` is passed to the callback. This property, however, has been
deprecated and use should be avoided.
-```mjs
+```mjs|cjs
import crypto from 'node:crypto';
crypto.DEFAULT_ENCODING = 'hex';
crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, derivedKey) => {
if (err) throw err;
console.log(derivedKey); // '3745e48...aa39b34'
});
-```
-
-```cjs
+--------------
const crypto = require('node:crypto');
crypto.DEFAULT_ENCODING = 'hex';
crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, derivedKey) => {
@@ -3807,16 +3719,14 @@ random and at least 16 bytes long. See [NIST SP 800-132][] for details.
When passing strings for `password` or `salt`, please consider
[caveats when using strings as inputs to cryptographic APIs][].
-```mjs
+```mjs|cjs
const {
pbkdf2Sync,
} = await import('node:crypto');
const key = pbkdf2Sync('secret', 'salt', 100000, 64, 'sha512');
console.log(key.toString('hex')); // '3745e48...08d59ae'
-```
-
-```cjs
+--------------
const {
pbkdf2Sync,
} = require('node:crypto');
@@ -3829,14 +3739,12 @@ The `crypto.DEFAULT_ENCODING` property may be used to change the way the
`derivedKey` is returned. This property, however, is deprecated and use
should be avoided.
-```mjs
+```mjs|cjs
import crypto from 'node:crypto';
crypto.DEFAULT_ENCODING = 'hex';
const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');
console.log(key); // '3745e48...aa39b34'
-```
-
-```cjs
+--------------
const crypto = require('node:crypto');
crypto.DEFAULT_ENCODING = 'hex';
const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');
@@ -3974,7 +3882,7 @@ and the `callback` function is invoked with two arguments: `err` and `buf`.
If an error occurs, `err` will be an `Error` object; otherwise it is `null`. The
`buf` argument is a [`Buffer`][] containing the generated bytes.
-```mjs
+```mjs|cjs
// Asynchronous
const {
randomBytes,
@@ -3984,9 +3892,7 @@ randomBytes(256, (err, buf) => {
if (err) throw err;
console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);
});
-```
-
-```cjs
+--------------
// Asynchronous
const {
randomBytes,
@@ -4002,7 +3908,7 @@ If the `callback` function is not provided, the random bytes are generated
synchronously and returned as a [`Buffer`][]. An error will be thrown if
there is a problem generating the bytes.
-```mjs
+```mjs|cjs
// Synchronous
const {
randomBytes,
@@ -4011,9 +3917,7 @@ const {
const buf = randomBytes(256);
console.log(
`${buf.length} bytes of random data: ${buf.toString('hex')}`);
-```
-
-```cjs
+--------------
// Synchronous
const {
randomBytes,
@@ -4053,7 +3957,7 @@ request.
Synchronous version of [`crypto.randomFill()`][].
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { randomFillSync } = await import('node:crypto');
@@ -4066,9 +3970,7 @@ console.log(buf.toString('hex'));
// The above is equivalent to the following:
randomFillSync(buf, 5, 5);
console.log(buf.toString('hex'));
-```
-
-```cjs
+--------------
const { randomFillSync } = require('node:crypto');
const { Buffer } = require('node:buffer');
@@ -4086,7 +3988,7 @@ console.log(buf.toString('hex'));
Any `ArrayBuffer`, `TypedArray` or `DataView` instance may be passed as
`buffer`.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { randomFillSync } = await import('node:crypto');
@@ -4100,9 +4002,7 @@ console.log(Buffer.from(randomFillSync(b).buffer,
const c = new ArrayBuffer(10);
console.log(Buffer.from(randomFillSync(c)).toString('hex'));
-```
-
-```cjs
+--------------
const { randomFillSync } = require('node:crypto');
const { Buffer } = require('node:buffer');
@@ -4135,7 +4035,7 @@ requires that a callback is passed in.
If the `callback` function is not provided, an error will be thrown.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { randomFill } = await import('node:crypto');
@@ -4155,9 +4055,7 @@ randomFill(buf, 5, 5, (err, buf) => {
if (err) throw err;
console.log(buf.toString('hex'));
});
-```
-
-```cjs
+--------------
const { randomFill } = require('node:crypto');
const { Buffer } = require('node:buffer');
@@ -4188,7 +4086,7 @@ result may contain `+Infinity`, `-Infinity`, and `NaN`, and even if the array
contains finite numbers only, they are not drawn from a uniform random
distribution and have no meaningful lower or upper bounds.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const { randomFill } = await import('node:crypto');
@@ -4211,9 +4109,7 @@ randomFill(c, (err, buf) => {
if (err) throw err;
console.log(Buffer.from(buf).toString('hex'));
});
-```
-
-```cjs
+--------------
const { randomFill } = require('node:crypto');
const { Buffer } = require('node:buffer');
@@ -4264,7 +4160,7 @@ be [safe integers][].
If the `callback` function is not provided, the random integer is
generated synchronously.
-```mjs
+```mjs|cjs
// Asynchronous
const {
randomInt,
@@ -4274,9 +4170,7 @@ randomInt(3, (err, n) => {
if (err) throw err;
console.log(`Random number chosen from (0, 1, 2): ${n}`);
});
-```
-
-```cjs
+--------------
// Asynchronous
const {
randomInt,
@@ -4288,7 +4182,7 @@ randomInt(3, (err, n) => {
});
```
-```mjs
+```mjs|cjs
// Synchronous
const {
randomInt,
@@ -4296,9 +4190,7 @@ const {
const n = randomInt(3);
console.log(`Random number chosen from (0, 1, 2): ${n}`);
-```
-
-```cjs
+--------------
// Synchronous
const {
randomInt,
@@ -4308,7 +4200,7 @@ const n = randomInt(3);
console.log(`Random number chosen from (0, 1, 2): ${n}`);
```
-```mjs
+```mjs|cjs
// With `min` argument
const {
randomInt,
@@ -4316,9 +4208,7 @@ const {
const n = randomInt(1, 7);
console.log(`The dice rolled: ${n}`);
-```
-
-```cjs
+--------------
// With `min` argument
const {
randomInt,
@@ -4381,7 +4271,7 @@ The `callback` function is called with two arguments: `err` and `derivedKey`.
An exception is thrown when any of the input arguments specify invalid values
or types.
-```mjs
+```mjs|cjs
const {
scrypt,
} = await import('node:crypto');
@@ -4396,9 +4286,7 @@ scrypt('password', 'salt', 64, { N: 1024 }, (err, derivedKey) => {
if (err) throw err;
console.log(derivedKey.toString('hex')); // '3745e48...aa39b34'
});
-```
-
-```cjs
+--------------
const {
scrypt,
} = require('node:crypto');
@@ -4450,7 +4338,7 @@ returned as a [`Buffer`][].
An exception is thrown when any of the input arguments specify invalid values
or types.
-```mjs
+```mjs|cjs
const {
scryptSync,
} = await import('node:crypto');
@@ -4461,9 +4349,7 @@ console.log(key1.toString('hex')); // '3745e48...08d59ae'
// Using a custom N parameter. Must be a power of two.
const key2 = scryptSync('password', 'salt', 64, { N: 1024 });
console.log(key2.toString('hex')); // '3745e48...aa39b34'
-```
-
-```cjs
+--------------
const {
scryptSync,
} = require('node:crypto');
@@ -4774,7 +4660,7 @@ mode must adhere to certain restrictions when using the cipher API:
applications _must_ call `final()` to compute or verify the
authentication tag.
-```mjs
+```mjs|cjs
import { Buffer } from 'node:buffer';
const {
createCipheriv,
@@ -4816,9 +4702,7 @@ try {
}
console.log(receivedPlaintext);
-```
-
-```cjs
+--------------
const { Buffer } = require('node:buffer');
const {
createCipheriv,
@@ -4880,7 +4764,7 @@ See the [list of SSL OP Flags][] for details.
SSL_OP_ALLApplies multiple bug workarounds within OpenSSL. See
- https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html
+ https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html
for detail.
@@ -4892,13 +4776,13 @@ See the [list of SSL OP Flags][] for details.
SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATIONAllows legacy insecure renegotiation between OpenSSL and unpatched
clients or servers. See
- https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html .
+ https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html .
SSL_OP_CIPHER_SERVER_PREFERENCEAttempts to use the server's preferences instead of the client's when
selecting a cipher. Behavior depends on protocol version. See
- https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html .
+ https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html .
SSL_OP_CISCO_ANYCONNECTInstructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability
workaround added in OpenSSL 0.9.6d.
-
- SSL_OP_EPHEMERAL_RSAInstructs OpenSSL to always use the tmp_rsa key when performing RSA
- operations.
-
SSL_OP_LEGACY_SERVER_CONNECTAllows initial connection to servers that do not support RI.
-
- SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
-
- SSL_OP_MICROSOFT_SESS_ID_BUG
-
- SSL_OP_MSIE_SSLV2_RSA_PADDINGInstructs OpenSSL to disable the workaround for a man-in-the-middle
- protocol-version vulnerability in the SSL 2.0 server implementation.
-
-
- SSL_OP_NETSCAPE_CA_DN_BUG
-
- SSL_OP_NETSCAPE_CHALLENGE_BUG
-
- SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG
-
- SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
SSL_OP_NO_COMPRESSIONInstructs OpenSSL to disable support for SSL/TLS compression.
@@ -5005,14 +4855,6 @@ See the [list of SSL OP Flags][] for details.
SSL_OP_NO_TLSv1_3Instructs OpenSSL to turn off TLS v1.3
-
- SSL_OP_PKCS1_CHECK_1
-
- SSL_OP_PKCS1_CHECK_2
SSL_OP_PRIORITIZE_CHACHAInstructs OpenSSL server to prioritize ChaCha20-Poly1305
@@ -5021,32 +4863,6 @@ See the [list of SSL OP Flags][] for details.
SSL_OP_CIPHER_SERVER_PREFERENCE
is not enabled.
-
- SSL_OP_SINGLE_DH_USEInstructs OpenSSL to always create a new key when using
- temporary/ephemeral DH parameters.
-
-
- SSL_OP_SINGLE_ECDH_USEInstructs OpenSSL to always create a new key when using
- temporary/ephemeral ECDH parameters.
-
-
- SSL_OP_SSLEAY_080_CLIENT_DH_BUG
-
- SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
-
- SSL_OP_TLS_BLOCK_PADDING_BUG
-
- SSL_OP_TLS_D5_BUG
SSL_OP_TLS_ROLLBACK_BUGInstructs OpenSSL to disable version rollback attack detection.
diff --git a/content/api/v19/debugger.en.md b/content/api/v19/debugger.en.md
index 24edaeb5b4..c34a977b1b 100644
--- a/content/api/v19/debugger.en.md
+++ b/content/api/v19/debugger.en.md
@@ -206,11 +206,19 @@ debug>
after)
* `watch(expr)`: Add expression to watch list
* `unwatch(expr)`: Remove expression from watch list
+* `unwatch(index)`: Remove expression at specific index from watch list
* `watchers`: List all watchers and their values (automatically listed on each
breakpoint)
* `repl`: Open debugger's repl for evaluation in debugging script's context
* `exec expr`, `p expr`: Execute an expression in debugging script's context and
print its value
+* `profile`: Start CPU profiling session
+* `profileEnd`: Stop current CPU profiling session
+* `profiles`: List all completed CPU profiling sessions
+* `profiles[n].save(filepath = 'node.cpuprofile')`: Save CPU profiling session
+ to disk as JSON
+* `takeHeapSnapshot(filepath = 'node.heapsnapshot')`: Take a heap snapshot
+ and save to disk as JSON
#### Execution control
diff --git a/content/api/v19/deprecations.en.md b/content/api/v19/deprecations.en.md
index 6692825663..948cb7d948 100644
--- a/content/api/v19/deprecations.en.md
+++ b/content/api/v19/deprecations.en.md
@@ -1864,7 +1864,7 @@ In a future version of Node.js, [`message.headers`][],
[`dnsPromises.lookup()`]: /api/v19/dns#dnspromiseslookuphostname-options
[`domain`]: /api/v19/domain
[`ecdh.setPublicKey()`]: /api/v19/crypto#ecdhsetpublickeypublickey-encoding
-[`emitter.listenerCount(eventName)`]: /api/v19/events#emitterlistenercounteventname
+[`emitter.listenerCount(eventName)`]: /api/v19/events#emitterlistenercounteventname-listener
[`events.listenerCount(emitter, eventName)`]: /api/v19/events#eventslistenercountemitter-eventname
[`fs.FileHandle`]: /api/v19/fs#class-filehandle
[`fs.access()`]: /api/v19/fs#fsaccesspath-mode-callback
diff --git a/content/api/v19/dgram.en.md b/content/api/v19/dgram.en.md
index b5ad015964..cfddeef29b 100644
--- a/content/api/v19/dgram.en.md
+++ b/content/api/v19/dgram.en.md
@@ -15,11 +15,11 @@ Stable
+
+Experimental
+
+
+
+* `path` [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) | [`Buffer`](/api/v19/buffer#buffer) | [`URL`](/api/v19/url#the-whatwg-url-api)
+* `options` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+ * `type` [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) An optional mime type for the blob.
+* Return: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) containing [`Blob`](/api/v19/buffer#blob)
+
+Returns a [`Blob`](/api/v19/buffer#blob) whose data is backed by the given file.
+
+The file must not be modified after the [`Blob`](/api/v19/buffer#blob) is created. Any modifications
+will cause reading the [`Blob`](/api/v19/buffer#blob) data to fail with a `DOMException`.
+error. Synchronous stat operations on the file when the `Blob` is created, and
+before each read in order to detect whether the file data has been modified
+on disk.
+
+```mjs|cjs
+import { openAsBlob } from 'node:fs';
+
+const blob = await openAsBlob('the.file.txt');
+const ab = await blob.arrayBuffer();
+blob.stream();
+--------------
+const { openAsBlob } = require('node:fs');
+
+(async () => {
+ const blob = await openAsBlob('the.file.txt');
+ const ab = await blob.arrayBuffer();
+ blob.stream();
+})();
+```
+
#### Hello World ');
});
-server.listen(80);
+server.listen(8000);
```
Even though HTTP/2 streams and network sockets are not in a 1:1 correspondence,
@@ -2167,7 +2167,7 @@ server.on('stream', (stream, headers) => {
stream.end('Hello World ');
});
-server.listen(80);
+server.listen(8000);
```
#### Hello World ');
});
-server.listen(80);
+server.listen(8443);
```
####
napi_value create_addon(napi_env env);
#endif // _ADDON_H_
-```
-
-```c
+--------------
// addon.c
#include "addon.h"
@@ -5727,12 +5723,10 @@ Experimental
-```c
+```c|text
NAPI_EXTERN napi_status
node_api_get_module_file_name(napi_env env, const char** result);
-```
-
* `[in] env`: The environment that the API is invoked under.
* `[out] result`: A URL containing the absolute path of the
location from which the add-on was loaded. For a file on the local
diff --git a/content/api/v19/navigation.json b/content/api/v19/navigation.json
index 89ab549ee5..a4c27b7326 100644
--- a/content/api/v19/navigation.json
+++ b/content/api/v19/navigation.json
@@ -1,4 +1,1835 @@
{
"version": "v19",
- "items": []
+ "items": [
+ {
+ "slug": "/api/v19/addons/",
+ "title": "C addons",
+ "type": "module",
+ "name": "addons"
+ },
+ {
+ "slug": "/api/v19/assert/",
+ "title": "Assert",
+ "type": "module",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v19/assert/#assertassertionerror",
+ "title": "assertAssertionError",
+ "type": "class",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v19/assert/#assertcalltracker",
+ "title": "assertCallTracker",
+ "type": "class",
+ "name": "assert"
+ },
+ {
+ "slug": "/api/v19/async_context/",
+ "title": "Asynchronous context tracking",
+ "type": "module",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v19/async_context/#asynclocalstorage",
+ "title": "AsyncLocalStorage",
+ "type": "class",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v19/async_context/#asyncresource",
+ "title": "AsyncResource",
+ "type": "class",
+ "name": "async_context"
+ },
+ {
+ "slug": "/api/v19/async_hooks/",
+ "title": "Async hooks",
+ "type": "module",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v19/async_hooks/#asynchook",
+ "title": "AsyncHook",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v19/async_hooks/#asynclocalstorage",
+ "title": "AsyncLocalStorage",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v19/async_hooks/#asyncresource",
+ "title": "AsyncResource",
+ "type": "class",
+ "name": "async_hooks"
+ },
+ {
+ "slug": "/api/v19/buffer/",
+ "title": "Buffer",
+ "type": "module",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v19/buffer/#blob",
+ "title": "Blob",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v19/buffer/#buffer",
+ "title": "Buffer",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v19/buffer/#file",
+ "title": "File",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v19/buffer/#slowbuffer",
+ "title": "SlowBuffer",
+ "type": "class",
+ "name": "buffer"
+ },
+ {
+ "slug": "/api/v19/child_process/",
+ "title": "Child process",
+ "type": "module",
+ "name": "child_process"
+ },
+ {
+ "slug": "/api/v19/child_process/#childprocess",
+ "title": "ChildProcess",
+ "type": "class",
+ "name": "child_process"
+ },
+ {
+ "slug": "/api/v19/cli/",
+ "title": "Command-line API",
+ "type": "module",
+ "name": "cli"
+ },
+ {
+ "slug": "/api/v19/cluster/",
+ "title": "Cluster",
+ "type": "module",
+ "name": "cluster"
+ },
+ {
+ "slug": "/api/v19/cluster/#worker",
+ "title": "Worker",
+ "type": "class",
+ "name": "cluster"
+ },
+ {
+ "slug": "/api/v19/console/",
+ "title": "Console",
+ "type": "module",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v19/console/#console",
+ "title": "Console",
+ "type": "class",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v19/console/#console",
+ "title": "Console",
+ "type": "class",
+ "name": "console"
+ },
+ {
+ "slug": "/api/v19/corepack/",
+ "title": "Corepack",
+ "type": "module",
+ "name": "corepack"
+ },
+ {
+ "slug": "/api/v19/crypto/",
+ "title": "Crypto",
+ "type": "module",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#certificate",
+ "title": "Certificate",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#cipher",
+ "title": "Cipher",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#decipher",
+ "title": "Decipher",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#diffiehellman",
+ "title": "DiffieHellman",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#diffiehellmangroup",
+ "title": "DiffieHellmanGroup",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#ecdh",
+ "title": "ECDH",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#hash",
+ "title": "Hash",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#hmac",
+ "title": "Hmac",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#keyobject",
+ "title": "KeyObject",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#sign",
+ "title": "Sign",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#verify",
+ "title": "Verify",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/crypto/#x509certificate",
+ "title": "X509Certificate",
+ "type": "class",
+ "name": "crypto"
+ },
+ {
+ "slug": "/api/v19/debugger/",
+ "title": "Debugger",
+ "type": "module",
+ "name": "debugger"
+ },
+ {
+ "slug": "/api/v19/deprecations/",
+ "title": "Deprecated APIs",
+ "type": "module",
+ "name": "deprecations"
+ },
+ {
+ "slug": "/api/v19/dgram/",
+ "title": "UDPdatagram sockets",
+ "type": "module",
+ "name": "dgram"
+ },
+ {
+ "slug": "/api/v19/dgram/#dgramsocket",
+ "title": "dgramSocket",
+ "type": "class",
+ "name": "dgram"
+ },
+ {
+ "slug": "/api/v19/diagnostics_channel/",
+ "title": "Diagnostics Channel",
+ "type": "module",
+ "name": "diagnostics_channel"
+ },
+ {
+ "slug": "/api/v19/diagnostics_channel/#channel",
+ "title": "Channel",
+ "type": "class",
+ "name": "diagnostics_channel"
+ },
+ {
+ "slug": "/api/v19/dns/",
+ "title": "DNS",
+ "type": "module",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v19/dns/#dnspromisesresolver",
+ "title": "dnsPromisesResolver",
+ "type": "class",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v19/dns/#dnsresolver",
+ "title": "dnsResolver",
+ "type": "class",
+ "name": "dns"
+ },
+ {
+ "slug": "/api/v19/documentation/",
+ "title": "About this documentation",
+ "type": "module",
+ "name": "documentation"
+ },
+ {
+ "slug": "/api/v19/domain/",
+ "title": "Domain",
+ "type": "module",
+ "name": "domain"
+ },
+ {
+ "slug": "/api/v19/domain/#domain",
+ "title": "Domain",
+ "type": "class",
+ "name": "domain"
+ },
+ {
+ "slug": "/api/v19/embedding/",
+ "title": "C embedder API",
+ "type": "module",
+ "name": "embedding"
+ },
+ {
+ "slug": "/api/v19/errors/",
+ "title": "Errors",
+ "type": "module",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/errors/#assertionerror",
+ "title": "AssertionError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/errors/#error",
+ "title": "Error",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/errors/#rangeerror",
+ "title": "RangeError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/errors/#referenceerror",
+ "title": "ReferenceError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/errors/#syntaxerror",
+ "title": "SyntaxError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/errors/#systemerror",
+ "title": "SystemError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/errors/#typeerror",
+ "title": "TypeError",
+ "type": "class",
+ "name": "errors"
+ },
+ {
+ "slug": "/api/v19/esm/",
+ "title": "ECMAScript modules",
+ "type": "module",
+ "name": "esm"
+ },
+ {
+ "slug": "/api/v19/events/",
+ "title": "Events",
+ "type": "module",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v19/events/#customevent",
+ "title": "CustomEvent",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v19/events/#event",
+ "title": "Event",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v19/events/#eventemitter",
+ "title": "EventEmitter",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v19/events/#eventseventemitterasyncresource-extends-eventemitter",
+ "title": "eventsEventEmitterAsyncResource extends EventEmitter",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v19/events/#eventtarget",
+ "title": "EventTarget",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v19/events/#nodeeventtarget",
+ "title": "NodeEventTarget",
+ "type": "class",
+ "name": "events"
+ },
+ {
+ "slug": "/api/v19/fs/",
+ "title": "File system",
+ "type": "module",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#filehandle",
+ "title": "FileHandle",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fsdir",
+ "title": "fsDir",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fsdirent",
+ "title": "fsDirent",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fsfswatcher",
+ "title": "fsFSWatcher",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fsreadstream",
+ "title": "fsReadStream",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fsstatfs",
+ "title": "fsStatFs",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fsstats",
+ "title": "fsStats",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fsstatwatcher",
+ "title": "fsStatWatcher",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/fs/#fswritestream",
+ "title": "fsWriteStream",
+ "type": "class",
+ "name": "fs"
+ },
+ {
+ "slug": "/api/v19/globals/",
+ "title": "Global objects",
+ "type": "module",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#abortcontroller",
+ "title": "AbortController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#abortcontroller",
+ "title": "AbortController",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#abortsignal",
+ "title": "AbortSignal",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#blob",
+ "title": "Blob",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#blob",
+ "title": "Blob",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#buffer",
+ "title": "Buffer",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#buffer",
+ "title": "Buffer",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#bytelengthqueuingstrategy",
+ "title": "ByteLengthQueuingStrategy",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#clearimmediateimmediateobject",
+ "title": "clearImmediate",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#clearintervalintervalobject",
+ "title": "clearInterval",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#cleartimeouttimeoutobject",
+ "title": "clearTimeout",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#compressionstream",
+ "title": "CompressionStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#console",
+ "title": "console",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#countqueuingstrategy",
+ "title": "CountQueuingStrategy",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#customevent",
+ "title": "CustomEvent",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#decompressionstream",
+ "title": "DecompressionStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#domexception",
+ "title": "DOMException",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#event",
+ "title": "Event",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#eventtarget",
+ "title": "EventTarget",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#global",
+ "title": "global",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#messagechannel",
+ "title": "MessageChannel",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#messageevent",
+ "title": "MessageEvent",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#messageport",
+ "title": "MessagePort",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#performanceentry",
+ "title": "PerformanceEntry",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#performancemark",
+ "title": "PerformanceMark",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#performancemeasure",
+ "title": "PerformanceMeasure",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#performanceobserver",
+ "title": "PerformanceObserver",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#performanceobserverentrylist",
+ "title": "PerformanceObserverEntryList",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#performanceresourcetiming",
+ "title": "PerformanceResourceTiming",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#process",
+ "title": "process",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#queuemicrotaskcallback",
+ "title": "queueMicrotask",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#readablebytestreamcontroller",
+ "title": "ReadableByteStreamController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#readablestream",
+ "title": "ReadableStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#readablestreambyobreader",
+ "title": "ReadableStreamBYOBReader",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#readablestreambyobrequest",
+ "title": "ReadableStreamBYOBRequest",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#readablestreamdefaultcontroller",
+ "title": "ReadableStreamDefaultController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#readablestreamdefaultreader",
+ "title": "ReadableStreamDefaultReader",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#setimmediatecallback-args",
+ "title": "setImmediate",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#setintervalcallback-delay-args",
+ "title": "setInterval",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#settimeoutcallback-delay-args",
+ "title": "setTimeout",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#structuredclonevalue-options",
+ "title": "structuredClone",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#textdecoder",
+ "title": "TextDecoder",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#textdecoderstream",
+ "title": "TextDecoderStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#textencoder",
+ "title": "TextEncoder",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#textencoderstream",
+ "title": "TextEncoderStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#transformstream",
+ "title": "TransformStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#transformstreamdefaultcontroller",
+ "title": "TransformStreamDefaultController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#url",
+ "title": "URL",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#urlsearchparams",
+ "title": "URLSearchParams",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#webassembly",
+ "title": "WebAssembly",
+ "type": "global",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#writablestream",
+ "title": "WritableStream",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#writablestreamdefaultcontroller",
+ "title": "WritableStreamDefaultController",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/globals/#writablestreamdefaultwriter",
+ "title": "WritableStreamDefaultWriter",
+ "type": "class",
+ "name": "globals"
+ },
+ {
+ "slug": "/api/v19/http/",
+ "title": "HTTP",
+ "type": "module",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v19/http/#httpagent",
+ "title": "httpAgent",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v19/http/#httpclientrequest",
+ "title": "httpClientRequest",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v19/http/#httpincomingmessage",
+ "title": "httpIncomingMessage",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v19/http/#httpoutgoingmessage",
+ "title": "httpOutgoingMessage",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v19/http/#httpserver",
+ "title": "httpServer",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v19/http/#httpserverresponse",
+ "title": "httpServerResponse",
+ "type": "class",
+ "name": "http"
+ },
+ {
+ "slug": "/api/v19/http2/",
+ "title": "HTTP2",
+ "type": "module",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#clienthttp2session",
+ "title": "ClientHttp2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#clienthttp2stream",
+ "title": "ClientHttp2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#http2http2serverrequest",
+ "title": "http2Http2ServerRequest",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#http2http2serverresponse",
+ "title": "http2Http2ServerResponse",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#http2secureserver",
+ "title": "Http2SecureServer",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#http2server",
+ "title": "Http2Server",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#http2session",
+ "title": "Http2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#http2stream",
+ "title": "Http2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#serverhttp2session",
+ "title": "ServerHttp2Session",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/http2/#serverhttp2stream",
+ "title": "ServerHttp2Stream",
+ "type": "class",
+ "name": "http2"
+ },
+ {
+ "slug": "/api/v19/https/",
+ "title": "HTTPS",
+ "type": "module",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v19/https/#httpsagent",
+ "title": "httpsAgent",
+ "type": "class",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v19/https/#httpsserver",
+ "title": "httpsServer",
+ "type": "class",
+ "name": "https"
+ },
+ {
+ "slug": "/api/v19/inspector/",
+ "title": "Inspector",
+ "type": "module",
+ "name": "inspector"
+ },
+ {
+ "slug": "/api/v19/inspector/#inspectorsession",
+ "title": "inspectorSession",
+ "type": "class",
+ "name": "inspector"
+ },
+ {
+ "slug": "/api/v19/inspector/#inspectorsession",
+ "title": "inspectorSession",
+ "type": "class",
+ "name": "inspector"
+ },
+ {
+ "slug": "/api/v19/intl/",
+ "title": "Internationalization support",
+ "type": "module",
+ "name": "intl"
+ },
+ {
+ "slug": "/api/v19/module/",
+ "title": "nodemodule API",
+ "type": "module",
+ "name": "module"
+ },
+ {
+ "slug": "/api/v19/module/#modulesourcemap",
+ "title": "moduleSourceMap",
+ "type": "class",
+ "name": "module"
+ },
+ {
+ "slug": "/api/v19/modules/",
+ "title": "CommonJS modules",
+ "type": "module",
+ "name": "modules"
+ },
+ {
+ "slug": "/api/v19/n-api/",
+ "title": "Node-API",
+ "type": "module",
+ "name": "n-api"
+ },
+ {
+ "slug": "/api/v19/net/",
+ "title": "Net",
+ "type": "module",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v19/net/#netblocklist",
+ "title": "netBlockList",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v19/net/#netserver",
+ "title": "netServer",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v19/net/#netsocket",
+ "title": "netSocket",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v19/net/#netsocketaddress",
+ "title": "netSocketAddress",
+ "type": "class",
+ "name": "net"
+ },
+ {
+ "slug": "/api/v19/os/",
+ "title": "OS",
+ "type": "module",
+ "name": "os"
+ },
+ {
+ "slug": "/api/v19/packages/",
+ "title": "Packages",
+ "type": "module",
+ "name": "packages"
+ },
+ {
+ "slug": "/api/v19/path/",
+ "title": "Path",
+ "type": "module",
+ "name": "path"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/",
+ "title": "Performance measurement APIs",
+ "type": "module",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#histogram",
+ "title": "Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#intervalhistogram-extends-histogram",
+ "title": "IntervalHistogram extends Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performanceentry",
+ "title": "PerformanceEntry",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performancemark",
+ "title": "PerformanceMark",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performancemeasure",
+ "title": "PerformanceMeasure",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performancenodeentry",
+ "title": "PerformanceNodeEntry",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performancenodetiming",
+ "title": "PerformanceNodeTiming",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performanceobserver",
+ "title": "PerformanceObserver",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performanceobserverentrylist",
+ "title": "PerformanceObserverEntryList",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#performanceresourcetiming",
+ "title": "PerformanceResourceTiming",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/perf_hooks/#recordablehistogram-extends-histogram",
+ "title": "RecordableHistogram extends Histogram",
+ "type": "class",
+ "name": "perf_hooks"
+ },
+ {
+ "slug": "/api/v19/permissions/",
+ "title": "Permissions",
+ "type": "module",
+ "name": "permissions"
+ },
+ {
+ "slug": "/api/v19/policy/",
+ "title": "Policies",
+ "type": "module",
+ "name": "policy"
+ },
+ {
+ "slug": "/api/v19/process/",
+ "title": "Process",
+ "type": "module",
+ "name": "process"
+ },
+ {
+ "slug": "/api/v19/punycode/",
+ "title": "Punycode",
+ "type": "module",
+ "name": "punycode"
+ },
+ {
+ "slug": "/api/v19/querystring/",
+ "title": "Query string",
+ "type": "module",
+ "name": "querystring"
+ },
+ {
+ "slug": "/api/v19/readline/",
+ "title": "Readline",
+ "type": "module",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v19/readline/#interfaceconstructor",
+ "title": "InterfaceConstructor",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v19/readline/#readlineinterface",
+ "title": "readlineInterface",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v19/readline/#readlinepromisesinterface",
+ "title": "readlinePromisesInterface",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v19/readline/#readlinepromisesreadline",
+ "title": "readlinePromisesReadline",
+ "type": "class",
+ "name": "readline"
+ },
+ {
+ "slug": "/api/v19/repl/",
+ "title": "REPL",
+ "type": "module",
+ "name": "repl"
+ },
+ {
+ "slug": "/api/v19/repl/#replserver",
+ "title": "REPLServer",
+ "type": "class",
+ "name": "repl"
+ },
+ {
+ "slug": "/api/v19/report/",
+ "title": "Diagnostic report",
+ "type": "module",
+ "name": "report"
+ },
+ {
+ "slug": "/api/v19/single-executable-applications/",
+ "title": "Single executable applications",
+ "type": "module",
+ "name": "single-executable-applications"
+ },
+ {
+ "slug": "/api/v19/stream/",
+ "title": "Stream",
+ "type": "module",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamduplex",
+ "title": "streamDuplex",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamduplex",
+ "title": "streamDuplex",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streampassthrough",
+ "title": "streamPassThrough",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamreadable",
+ "title": "streamReadable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamreadable",
+ "title": "streamReadable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamtransform",
+ "title": "streamTransform",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamtransform",
+ "title": "streamTransform",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamwritable",
+ "title": "streamWritable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/stream/#streamwritable",
+ "title": "streamWritable",
+ "type": "class",
+ "name": "stream"
+ },
+ {
+ "slug": "/api/v19/string_decoder/",
+ "title": "String decoder",
+ "type": "module",
+ "name": "string_decoder"
+ },
+ {
+ "slug": "/api/v19/string_decoder/#stringdecoder",
+ "title": "StringDecoder",
+ "type": "class",
+ "name": "string_decoder"
+ },
+ {
+ "slug": "/api/v19/synopsis/",
+ "title": "Usage and example",
+ "type": "module",
+ "name": "synopsis"
+ },
+ {
+ "slug": "/api/v19/test/",
+ "title": "Test runner",
+ "type": "module",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v19/test/#mockfunctioncontext",
+ "title": "MockFunctionContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v19/test/#mocktracker",
+ "title": "MockTracker",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v19/test/#suitecontext",
+ "title": "SuiteContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v19/test/#testcontext",
+ "title": "TestContext",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v19/test/#testsstream",
+ "title": "TestsStream",
+ "type": "class",
+ "name": "test"
+ },
+ {
+ "slug": "/api/v19/timers/",
+ "title": "Timers",
+ "type": "module",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v19/timers/#immediate",
+ "title": "Immediate",
+ "type": "class",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v19/timers/#timeout",
+ "title": "Timeout",
+ "type": "class",
+ "name": "timers"
+ },
+ {
+ "slug": "/api/v19/tls/",
+ "title": "TLS ",
+ "type": "module",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v19/tls/#tlscryptostream",
+ "title": "tlsCryptoStream",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v19/tls/#tlssecurepair",
+ "title": "tlsSecurePair",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v19/tls/#tlsserver",
+ "title": "tlsServer",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v19/tls/#tlstlssocket",
+ "title": "tlsTLSSocket",
+ "type": "class",
+ "name": "tls"
+ },
+ {
+ "slug": "/api/v19/tracing/",
+ "title": "Trace events",
+ "type": "module",
+ "name": "tracing"
+ },
+ {
+ "slug": "/api/v19/tty/",
+ "title": "TTY",
+ "type": "module",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v19/tty/#ttyreadstream",
+ "title": "ttyReadStream",
+ "type": "class",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v19/tty/#ttywritestream",
+ "title": "ttyWriteStream",
+ "type": "class",
+ "name": "tty"
+ },
+ {
+ "slug": "/api/v19/url/",
+ "title": "URL",
+ "type": "module",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v19/url/#url",
+ "title": "URL",
+ "type": "class",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v19/url/#urlsearchparams",
+ "title": "URLSearchParams",
+ "type": "class",
+ "name": "url"
+ },
+ {
+ "slug": "/api/v19/util/",
+ "title": "Util",
+ "type": "module",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v19/util/#utilmimeparams",
+ "title": "utilMIMEParams",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v19/util/#utilmimetype",
+ "title": "utilMIMEType",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v19/util/#utiltextdecoder",
+ "title": "utilTextDecoder",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v19/util/#utiltextencoder",
+ "title": "utilTextEncoder",
+ "type": "class",
+ "name": "util"
+ },
+ {
+ "slug": "/api/v19/v8/",
+ "title": "V8",
+ "type": "module",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v19/v8/#v8defaultdeserializer",
+ "title": "v8DefaultDeserializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v19/v8/#v8defaultserializer",
+ "title": "v8DefaultSerializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v19/v8/#v8deserializer",
+ "title": "v8Deserializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v19/v8/#v8gcprofiler",
+ "title": "v8GCProfiler",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v19/v8/#v8serializer",
+ "title": "v8Serializer",
+ "type": "class",
+ "name": "v8"
+ },
+ {
+ "slug": "/api/v19/vm/",
+ "title": "VM ",
+ "type": "module",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v19/vm/#vmmodule",
+ "title": "vmModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v19/vm/#vmscript",
+ "title": "vmScript",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v19/vm/#vmsourcetextmodule",
+ "title": "vmSourceTextModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v19/vm/#vmsyntheticmodule",
+ "title": "vmSyntheticModule",
+ "type": "class",
+ "name": "vm"
+ },
+ {
+ "slug": "/api/v19/wasi/",
+ "title": "WebAssembly System Interface ",
+ "type": "module",
+ "name": "wasi"
+ },
+ {
+ "slug": "/api/v19/wasi/#wasi",
+ "title": "WASI",
+ "type": "class",
+ "name": "wasi"
+ },
+ {
+ "slug": "/api/v19/webcrypto/",
+ "title": "Web Crypto API",
+ "type": "module",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#aescbcparams",
+ "title": "AesCbcParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#aesctrparams",
+ "title": "AesCtrParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#aesgcmparams",
+ "title": "AesGcmParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#aeskeygenparams",
+ "title": "AesKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#algorithmidentifier",
+ "title": "AlgorithmIdentifier",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#crypto",
+ "title": "Crypto",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#cryptokey",
+ "title": "CryptoKey",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#cryptokeypair",
+ "title": "CryptoKeyPair",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#ecdhkeyderiveparams",
+ "title": "EcdhKeyDeriveParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#ecdsaparams",
+ "title": "EcdsaParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#eckeygenparams",
+ "title": "EcKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#eckeyimportparams",
+ "title": "EcKeyImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#ed448params",
+ "title": "Ed448Params",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#hkdfparams",
+ "title": "HkdfParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#hmacimportparams",
+ "title": "HmacImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#hmackeygenparams",
+ "title": "HmacKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#pbkdf2params",
+ "title": "Pbkdf2Params",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#rsahashedimportparams",
+ "title": "RsaHashedImportParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#rsahashedkeygenparams",
+ "title": "RsaHashedKeyGenParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#rsaoaepparams",
+ "title": "RsaOaepParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#rsapssparams",
+ "title": "RsaPssParams",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webcrypto/#subtlecrypto",
+ "title": "SubtleCrypto",
+ "type": "class",
+ "name": "webcrypto"
+ },
+ {
+ "slug": "/api/v19/webstreams/",
+ "title": "Web Streams API",
+ "type": "module",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#bytelengthqueuingstrategy",
+ "title": "ByteLengthQueuingStrategy",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#compressionstream",
+ "title": "CompressionStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#countqueuingstrategy",
+ "title": "CountQueuingStrategy",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#decompressionstream",
+ "title": "DecompressionStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#readablebytestreamcontroller",
+ "title": "ReadableByteStreamController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#readablestream",
+ "title": "ReadableStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#readablestreambyobreader",
+ "title": "ReadableStreamBYOBReader",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#readablestreambyobrequest",
+ "title": "ReadableStreamBYOBRequest",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#readablestreamdefaultcontroller",
+ "title": "ReadableStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#readablestreamdefaultreader",
+ "title": "ReadableStreamDefaultReader",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#textdecoderstream",
+ "title": "TextDecoderStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#textencoderstream",
+ "title": "TextEncoderStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#transformstream",
+ "title": "TransformStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#transformstreamdefaultcontroller",
+ "title": "TransformStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#writablestream",
+ "title": "WritableStream",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#writablestreamdefaultcontroller",
+ "title": "WritableStreamDefaultController",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/webstreams/#writablestreamdefaultwriter",
+ "title": "WritableStreamDefaultWriter",
+ "type": "class",
+ "name": "webstreams"
+ },
+ {
+ "slug": "/api/v19/worker_threads/",
+ "title": "Worker threads",
+ "type": "module",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v19/worker_threads/#broadcastchannel-extends-eventtarget",
+ "title": "BroadcastChannel extends EventTarget",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v19/worker_threads/#messagechannel",
+ "title": "MessageChannel",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v19/worker_threads/#messageport",
+ "title": "MessagePort",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v19/worker_threads/#worker",
+ "title": "Worker",
+ "type": "class",
+ "name": "worker_threads"
+ },
+ {
+ "slug": "/api/v19/zlib/",
+ "title": "Zlib",
+ "type": "module",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#brotlioptions",
+ "title": "BrotliOptions",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#options",
+ "title": "Options",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibbrotlicompress",
+ "title": "zlibBrotliCompress",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibbrotlidecompress",
+ "title": "zlibBrotliDecompress",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibdeflate",
+ "title": "zlibDeflate",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibdeflateraw",
+ "title": "zlibDeflateRaw",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibgunzip",
+ "title": "zlibGunzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibgzip",
+ "title": "zlibGzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibinflate",
+ "title": "zlibInflate",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibinflateraw",
+ "title": "zlibInflateRaw",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibunzip",
+ "title": "zlibUnzip",
+ "type": "class",
+ "name": "zlib"
+ },
+ {
+ "slug": "/api/v19/zlib/#zlibzlibbase",
+ "title": "zlibZlibBase",
+ "type": "class",
+ "name": "zlib"
+ }
+ ]
}
\ No newline at end of file
diff --git a/content/api/v19/net.en.md b/content/api/v19/net.en.md
index 5231a57ec2..f2573ec4ca 100644
--- a/content/api/v19/net.en.md
+++ b/content/api/v19/net.en.md
@@ -13,7 +13,7 @@ Stable
-)
// at main (*)
// First call
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('multipleResolves', (type, promise, reason) => {
@@ -291,7 +281,7 @@ In asynchronous code, the `'unhandledRejection'` event is emitted when the list
of unhandled rejections grows, and the `'rejectionHandled'` event is emitted
when the list of unhandled rejections shrinks.
-```mjs
+```mjs|cjs
import process from 'node:process';
const unhandledRejections = new Map();
@@ -301,9 +291,7 @@ process.on('unhandledRejection', (reason, promise) => {
process.on('rejectionHandled', (promise) => {
unhandledRejections.delete(promise);
});
-```
-
-```cjs
+--------------
const process = require('node:process');
const unhandledRejections = new Map();
@@ -344,7 +332,7 @@ behavior. Alternatively, change the [`process.exitCode`][] in the
provided exit code. Otherwise, in the presence of such handler the process will
exit with 0.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('uncaughtException', (err, origin) => {
@@ -362,9 +350,7 @@ setTimeout(() => {
// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
console.log('This will not run.');
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('uncaughtException', (err, origin) => {
@@ -436,7 +422,7 @@ Installing an `'uncaughtExceptionMonitor'` listener does not change the behavior
once an `'uncaughtException'` event is emitted. The process will
still crash if no `'uncaughtException'` listener is installed.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('uncaughtExceptionMonitor', (err, origin) => {
@@ -446,9 +432,7 @@ process.on('uncaughtExceptionMonitor', (err, origin) => {
// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
// Still crashes Node.js
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('uncaughtExceptionMonitor', (err, origin) => {
@@ -476,7 +460,7 @@ are propagated through a `Promise` chain. The `'unhandledRejection'` event is
useful for detecting and keeping track of promises that were rejected whose
rejections have not yet been handled.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('unhandledRejection', (reason, promise) => {
@@ -487,9 +471,7 @@ process.on('unhandledRejection', (reason, promise) => {
somePromise.then((res) => {
return reportToUser(JSON.pasre(res)); // Note the typo (`pasre`)
}); // No `.catch()` or `.then()`
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('unhandledRejection', (reason, promise) => {
@@ -505,7 +487,7 @@ somePromise.then((res) => {
The following will also trigger the `'unhandledRejection'` event to be
emitted:
-```mjs
+```mjs|cjs
import process from 'node:process';
function SomeResource() {
@@ -515,9 +497,7 @@ function SomeResource() {
const resource = new SomeResource();
// no .catch or .then on resource.loaded for at least a turn
-```
-
-```cjs
+--------------
const process = require('node:process');
function SomeResource() {
@@ -554,7 +534,7 @@ are not part of the normal Node.js and JavaScript error handling flow.
Node.js can emit warnings whenever it detects bad coding practices that could
lead to sub-optimal application performance, bugs, or security vulnerabilities.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('warning', (warning) => {
@@ -562,9 +542,7 @@ process.on('warning', (warning) => {
console.warn(warning.message); // Print the warning message
console.warn(warning.stack); // Print the stack trace
});
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('warning', (warning) => {
@@ -671,7 +649,7 @@ The signal handler will receive the signal's name (`'SIGINT'`,
The name of each event will be the uppercase common name for the signal (e.g.
`'SIGINT'` for `SIGINT` signals).
-```mjs
+```mjs|cjs
import process from 'node:process';
// Begin reading from stdin so the process does not exit.
@@ -688,9 +666,7 @@ function handle(signal) {
process.on('SIGINT', handle);
process.on('SIGTERM', handle);
-```
-
-```cjs
+--------------
const process = require('node:process');
// Begin reading from stdin so the process does not exit.
@@ -793,7 +769,7 @@ appear only _once_; each will begin with one or more dashes. Flags
passed through to V8 will contain underscores instead of non-leading
dashes:
-```mjs
+```mjs|cjs
import { allowedNodeEnvironmentFlags } from 'node:process';
allowedNodeEnvironmentFlags.forEach((flag) => {
@@ -802,9 +778,7 @@ allowedNodeEnvironmentFlags.forEach((flag) => {
// --abort_on_uncaught_exception
// ...
});
-```
-
-```cjs
+--------------
const { allowedNodeEnvironmentFlags } = require('node:process');
allowedNodeEnvironmentFlags.forEach((flag) => {
@@ -833,13 +807,11 @@ The operating system CPU architecture for which the Node.js binary was compiled.
Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`,
`'ppc64'`, `'s390'`, `'s390x'`, and `'x64'`.
-```mjs
+```mjs|cjs
import { arch } from 'node:process';
console.log(`This processor architecture is ${arch}`);
-```
-
-```cjs
+--------------
const { arch } = require('node:process');
console.log(`This processor architecture is ${arch}`);
@@ -860,16 +832,14 @@ arguments.
For example, assuming the following script for `process-args.js`:
-```mjs
+```mjs|cjs
import { argv } from 'node:process';
// print process.argv
argv.forEach((val, index) => {
console.log(`${index}: ${val}`);
});
-```
-
-```cjs
+--------------
const { argv } = require('node:process');
// print process.argv
@@ -954,7 +924,7 @@ The `process.chdir()` method changes the current working directory of the
Node.js process or throws an exception if doing so fails (for instance, if
the specified `directory` does not exist).
-```mjs
+```mjs|cjs
import { chdir, cwd } from 'node:process';
console.log(`Starting directory: ${cwd()}`);
@@ -964,9 +934,7 @@ try {
} catch (err) {
console.error(`chdir: ${err}`);
}
-```
-
-```cjs
+--------------
const { chdir, cwd } = require('node:process');
console.log(`Starting directory: ${cwd()}`);
@@ -1072,7 +1040,7 @@ actual elapsed time if multiple CPU cores are performing work for this process.
The result of a previous call to `process.cpuUsage()` can be passed as the
argument to the function, to get a diff reading.
-```mjs
+```mjs|cjs
import { cpuUsage } from 'node:process';
const startUsage = cpuUsage();
@@ -1084,9 +1052,7 @@ while (Date.now() - now < 500);
console.log(cpuUsage(startUsage));
// { user: 514883, system: 11226 }
-```
-
-```cjs
+--------------
const { cpuUsage } = require('node:process');
const startUsage = cpuUsage();
@@ -1109,13 +1075,11 @@ console.log(cpuUsage(startUsage));
The `process.cwd()` method returns the current working directory of the Node.js
process.
-```mjs
+```mjs|cjs
import { cwd } from 'node:process';
console.log(`Current directory: ${cwd()}`);
-```
-
-```cjs
+--------------
const { cwd } = require('node:process');
console.log(`Current directory: ${cwd()}`);
@@ -1129,13 +1093,11 @@ console.log(`Current directory: ${cwd()}`);
The port used by the Node.js debugger when enabled.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.debugPort = 5858;
-```
-
-```cjs
+--------------
const process = require('node:process');
process.debugPort = 5858;
@@ -1182,7 +1144,7 @@ that exports a `foo` function. All the symbols are loaded before
the call returns, by passing the `RTLD_NOW` constant. In this example
the constant is assumed to be available.
-```mjs
+```mjs|cjs
import { dlopen } from 'node:process';
import { constants } from 'node:os';
import { fileURLToPath } from 'node:url';
@@ -1191,9 +1153,7 @@ const module = { exports: {} };
dlopen(module, fileURLToPath(new URL('local.node', import.meta.url)),
constants.dlopen.RTLD_NOW);
module.exports.foo();
-```
-
-```cjs
+--------------
const { dlopen } = require('node:process');
const { constants } = require('node:os');
const { join } = require('node:path');
@@ -1221,7 +1181,7 @@ The `process.emitWarning()` method can be used to emit custom or application
specific process warnings. These can be listened for by adding a handler to the
[`'warning'`][process_warning] event.
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning with a code and additional detail.
@@ -1232,9 +1192,7 @@ emitWarning('Something happened!', {
// Emits:
// (node:56338) [MY_WARNING] Warning: Something happened!
// This is some additional information
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning with a code and additional detail.
@@ -1251,7 +1209,7 @@ In this example, an `Error` object is generated internally by
`process.emitWarning()` and passed through to the
[`'warning'`][process_warning] handler.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('warning', (warning) => {
@@ -1261,9 +1219,7 @@ process.on('warning', (warning) => {
console.warn(warning.stack); // Stack trace
console.warn(warning.detail); // 'This is some additional information'
});
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('warning', (warning) => {
@@ -1293,15 +1249,13 @@ The `process.emitWarning()` method can be used to emit custom or application
specific process warnings. These can be listened for by adding a handler to the
[`'warning'`][process_warning] event.
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning using a string.
emitWarning('Something happened!');
// Emits: (node: 56338) Warning: Something happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning using a string.
@@ -1309,15 +1263,13 @@ emitWarning('Something happened!');
// Emits: (node: 56338) Warning: Something happened!
```
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning using a string and a type.
emitWarning('Something Happened!', 'CustomWarning');
// Emits: (node:56338) CustomWarning: Something Happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning using a string and a type.
@@ -1325,14 +1277,12 @@ emitWarning('Something Happened!', 'CustomWarning');
// Emits: (node:56338) CustomWarning: Something Happened!
```
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
emitWarning('Something happened!', 'CustomWarning', 'WARN001');
// Emits: (node:56338) [WARN001] CustomWarning: Something happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
process.emitWarning('Something happened!', 'CustomWarning', 'WARN001');
@@ -1343,7 +1293,7 @@ In each of the previous examples, an `Error` object is generated internally by
`process.emitWarning()` and passed through to the [`'warning'`][process_warning]
handler.
-```mjs
+```mjs|cjs
import process from 'node:process';
process.on('warning', (warning) => {
@@ -1352,9 +1302,7 @@ process.on('warning', (warning) => {
console.warn(warning.code);
console.warn(warning.stack);
});
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('warning', (warning) => {
@@ -1369,7 +1317,7 @@ If `warning` is passed as an `Error` object, it will be passed through to the
`'warning'` event handler unmodified (and the optional `type`,
`code` and `ctor` arguments will be ignored):
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
// Emit a warning using an Error object.
@@ -1380,9 +1328,7 @@ myWarning.code = 'WARN001';
emitWarning(myWarning);
// Emits: (node:56338) [WARN001] CustomWarning: Something happened!
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
// Emit a warning using an Error object.
@@ -1416,7 +1362,7 @@ The following additional handling is implemented if the warning `type` is
As a best practice, warnings should be emitted only once per process. To do
so, place the `emitWarning()` behind a boolean.
-```mjs
+```mjs|cjs
import { emitWarning } from 'node:process';
function emitMyWarning() {
@@ -1429,9 +1375,7 @@ emitMyWarning();
// Emits: (node: 56339) Warning: Only warn once!
emitMyWarning();
// Emits nothing
-```
-
-```cjs
+--------------
const { emitWarning } = require('node:process');
function emitMyWarning() {
@@ -1483,14 +1427,12 @@ $ node -e 'process.env.foo = "bar"' && echo $foo
While the following will:
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.foo = 'bar';
console.log(env.foo);
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.foo = 'bar';
@@ -1501,7 +1443,7 @@ Assigning a property on `process.env` will implicitly convert the value
to a string. **This behavior is deprecated.** Future versions of Node.js may
throw an error when the value is not a string, number, or boolean.
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.test = null;
@@ -1510,9 +1452,7 @@ console.log(env.test);
env.test = undefined;
console.log(env.test);
// => 'undefined'
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.test = null;
@@ -1525,16 +1465,14 @@ console.log(env.test);
Use `delete` to delete a property from `process.env`.
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.TEST = 1;
delete env.TEST;
console.log(env.TEST);
// => undefined
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.TEST = 1;
@@ -1545,15 +1483,13 @@ console.log(env.TEST);
On Windows operating systems, environment variables are case-insensitive.
-```mjs
+```mjs|cjs
import { env } from 'node:process';
env.TEST = 1;
console.log(env.test);
// => 1
-```
-
-```cjs
+--------------
const { env } = require('node:process');
env.TEST = 1;
@@ -1627,13 +1563,11 @@ called.
To exit with a 'failure' code:
-```mjs
+```mjs|cjs
import { exit } from 'node:process';
exit(1);
-```
-
-```cjs
+--------------
const { exit } = require('node:process');
exit(1);
@@ -1655,7 +1589,7 @@ For instance, the following example illustrates a _misuse_ of the
`process.exit()` method that could lead to data printed to stdout being
truncated and lost:
-```mjs
+```mjs|cjs
import { exit } from 'node:process';
// This is an example of what *not* to do:
@@ -1663,9 +1597,7 @@ if (someConditionNotMet()) {
printUsageToStdout();
exit(1);
}
-```
-
-```cjs
+--------------
const { exit } = require('node:process');
// This is an example of what *not* to do:
@@ -1684,7 +1616,7 @@ Rather than calling `process.exit()` directly, the code _should_ set the
`process.exitCode` and allow the process to exit naturally by avoiding
scheduling any additional work for the event loop:
-```mjs
+```mjs|cjs
import process from 'node:process';
// How to properly set the exit code while letting
@@ -1693,9 +1625,7 @@ if (someConditionNotMet()) {
printUsageToStdout();
process.exitCode = 1;
}
-```
-
-```cjs
+--------------
const process = require('node:process');
// How to properly set the exit code while letting
@@ -1742,7 +1672,7 @@ The `process.getActiveResourcesInfo()` method returns an array of strings
containing the types of the active resources that are currently keeping the
event loop alive.
-```mjs
+```mjs|cjs
import { getActiveResourcesInfo } from 'node:process';
import { setTimeout } from 'node:timers';
@@ -1752,9 +1682,7 @@ console.log('After:', getActiveResourcesInfo());
// Prints:
// Before: [ 'CloseReq', 'TTYWrap', 'TTYWrap', 'TTYWrap' ]
// After: [ 'CloseReq', 'TTYWrap', 'TTYWrap', 'TTYWrap', 'Timeout' ]
-```
-
-```cjs
+--------------
const { getActiveResourcesInfo } = require('node:process');
const { setTimeout } = require('node:timers');
@@ -1773,15 +1701,13 @@ console.log('After:', getActiveResourcesInfo());
The `process.getegid()` method returns the numerical effective group identity
of the Node.js process. (See getegid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getegid) {
console.log(`Current gid: ${process.getegid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getegid) {
@@ -1801,15 +1727,13 @@ Android).
The `process.geteuid()` method returns the numerical effective user identity of
the process. (See geteuid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.geteuid) {
console.log(`Current uid: ${process.geteuid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.geteuid) {
@@ -1829,15 +1753,13 @@ Android).
The `process.getgid()` method returns the numerical group identity of the
process. (See getgid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgid) {
console.log(`Current gid: ${process.getgid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgid) {
@@ -1858,15 +1780,13 @@ The `process.getgroups()` method returns an array with the supplementary group
IDs. POSIX leaves it unspecified if the effective group ID is included but
Node.js ensures it always is.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgroups) {
console.log(process.getgroups()); // [ 16, 21, 297 ]
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgroups) {
@@ -1886,15 +1806,13 @@ Android).
The `process.getuid()` method returns the numeric user identity of the process.
(See getuid(2).)
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getuid) {
console.log(`Current uid: ${process.getuid()}`);
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getuid) {
@@ -1944,7 +1862,7 @@ These times are relative to an arbitrary time in the
past, and not related to the time of day and therefore not subject to clock
drift. The primary use is for measuring performance between intervals:
-```mjs
+```mjs|cjs
import { hrtime } from 'node:process';
const NS_PER_SEC = 1e9;
@@ -1958,9 +1876,7 @@ setTimeout(() => {
console.log(`Benchmark took ${diff[0] * NS_PER_SEC + diff[1]} nanoseconds`);
// Benchmark took 1000000552 nanoseconds
}, 1000);
-```
-
-```cjs
+--------------
const { hrtime } = require('node:process');
const NS_PER_SEC = 1e9;
@@ -1989,7 +1905,7 @@ Unlike [`process.hrtime()`][], it does not support an additional `time`
argument since the difference can just be computed directly
by subtraction of the two `bigint`s.
-```mjs
+```mjs|cjs
import { hrtime } from 'node:process';
const start = hrtime.bigint();
@@ -2002,9 +1918,7 @@ setTimeout(() => {
console.log(`Benchmark took ${end - start} nanoseconds`);
// Benchmark took 1154389282 nanoseconds
}, 1000);
-```
-
-```cjs
+--------------
const { hrtime } = require('node:process');
const start = hrtime.bigint();
@@ -2033,7 +1947,7 @@ access or the `CAP_SETGID` capability.
Use care when dropping privileges:
-```mjs
+```mjs|cjs
import { getgroups, initgroups, setgid } from 'node:process';
console.log(getgroups()); // [ 0 ]
@@ -2041,9 +1955,7 @@ initgroups('nodeuser', 1000); // switch user
console.log(getgroups()); // [ 27, 30, 46, 1000, 0 ]
setgid(1000); // drop root gid
console.log(getgroups()); // [ 27, 30, 46, 1000 ]
-```
-
-```cjs
+--------------
const { getgroups, initgroups, setgid } = require('node:process');
console.log(getgroups()); // [ 0 ]
@@ -2080,7 +1992,7 @@ Even though the name of this function is `process.kill()`, it is really just a
signal sender, like the `kill` system call. The signal sent may do something
other than kill the target process.
-```mjs
+```mjs|cjs
import process, { kill } from 'node:process';
process.on('SIGHUP', () => {
@@ -2093,9 +2005,7 @@ setTimeout(() => {
}, 100);
kill(process.pid, 'SIGHUP');
-```
-
-```cjs
+--------------
const process = require('node:process');
process.on('SIGHUP', () => {
@@ -2148,7 +2058,7 @@ is no entry script.
Returns an object describing the memory usage of the Node.js process measured in
bytes.
-```mjs
+```mjs|cjs
import { memoryUsage } from 'node:process';
console.log(memoryUsage());
@@ -2160,9 +2070,7 @@ console.log(memoryUsage());
// external: 49879,
// arrayBuffers: 9386
// }
-```
-
-```cjs
+--------------
const { memoryUsage } = require('node:process');
console.log(memoryUsage());
@@ -2211,14 +2119,12 @@ process, including all C++ and JavaScript objects and code.
This is the same value as the `rss` property provided by `process.memoryUsage()`
but `process.memoryUsage.rss()` is faster.
-```mjs
+```mjs|cjs
import { memoryUsage } from 'node:process';
console.log(memoryUsage.rss());
// 35655680
-```
-
-```cjs
+--------------
const { rss } = require('node:process');
console.log(memoryUsage.rss());
@@ -2238,7 +2144,7 @@ completion and before the event loop is allowed to continue. It's possible to
create an infinite loop if one were to recursively call `process.nextTick()`.
See the [Event Loop][] guide for more background.
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
console.log('start');
@@ -2250,9 +2156,7 @@ console.log('scheduled');
// start
// scheduled
// nextTick callback
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
console.log('start');
@@ -2270,7 +2174,7 @@ This is important when developing APIs in order to give users the opportunity
to assign event handlers _after_ an object has been constructed but before any
I/O has occurred:
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
function MyThing(options) {
@@ -2285,9 +2189,7 @@ const thing = new MyThing();
thing.getReadyForStuff();
// thing.startDoingStuff() gets called now, not before.
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
function MyThing(options) {
@@ -2335,7 +2237,7 @@ It is not clear whether `foo()` or `bar()` will be called first.
The following approach is much better:
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
function definitelyAsync(arg, cb) {
@@ -2346,9 +2248,7 @@ function definitelyAsync(arg, cb) {
fs.stat('file', cb);
}
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
function definitelyAsync(arg, cb) {
@@ -2369,7 +2269,7 @@ execute the then, catch, and finally handlers of resolved promises. Within
Node.js, every time the "next tick queue" is drained, the microtask queue
is drained immediately after.
-```mjs
+```mjs|cjs
import { nextTick } from 'node:process';
Promise.resolve().then(() => console.log(2));
@@ -2379,9 +2279,7 @@ nextTick(() => console.log(1));
// 1
// 2
// 3
-```
-
-```cjs
+--------------
const { nextTick } = require('node:process');
Promise.resolve().then(() => console.log(2));
@@ -2459,13 +2357,11 @@ flag's behavior.
The `process.pid` property returns the PID of the process.
-```mjs
+```mjs|cjs
import { pid } from 'node:process';
console.log(`This process is pid ${pid}`);
-```
-
-```cjs
+--------------
const { pid } = require('node:process');
console.log(`This process is pid ${pid}`);
@@ -2490,13 +2386,11 @@ Currently possible values are:
* `'sunos'`
* `'win32'`
-```mjs
+```mjs|cjs
import { platform } from 'node:process';
console.log(`This platform is ${platform}`);
-```
-
-```cjs
+--------------
const { platform } = require('node:process');
console.log(`This platform is ${platform}`);
@@ -2515,13 +2409,11 @@ Android operating system. However, Android support in Node.js
The `process.ppid` property returns the PID of the parent of the
current process.
-```mjs
+```mjs|cjs
import { ppid } from 'node:process';
console.log(`The parent process is pid ${ppid}`);
-```
-
-```cjs
+--------------
const { ppid } = require('node:process');
console.log(`The parent process is pid ${ppid}`);
@@ -2593,13 +2485,11 @@ Write reports in a compact format, single-line JSON, more easily consumable
by log processing systems than the default multi-line format designed for
human consumption.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Reports are compact? ${report.compact}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Reports are compact? ${report.compact}`);
@@ -2615,13 +2505,11 @@ Directory where the report is written. The default value is the empty string,
indicating that reports are written to the current working directory of the
Node.js process.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report directory is ${report.directory}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report directory is ${report.directory}`);
@@ -2640,13 +2528,11 @@ value is the empty string.
If the value of `process.report.filename` is set to `'stdout'` or `'stderr'`,
the report is written to the stdout or stderr of the process respectively.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report filename is ${report.filename}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report filename is ${report.filename}`);
@@ -2663,7 +2549,7 @@ Returns a JavaScript Object representation of a diagnostic report for the
running process. The report's JavaScript stack trace is taken from `err`, if
present.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
const data = report.getReport();
@@ -2672,9 +2558,7 @@ console.log(data.header.nodejsVersion);
// Similar to process.report.writeReport()
import fs from 'node:fs';
fs.writeFileSync('my-report.log', util.inspect(data), 'utf8');
-```
-
-```cjs
+--------------
const { report } = require('node:process');
const data = report.getReport();
@@ -2696,13 +2580,11 @@ Additional documentation is available in the [report documentation][].
If `true`, a diagnostic report is generated on fatal errors, such as out of
memory errors or failed C++ assertions.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report on fatal error: ${report.reportOnFatalError}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report on fatal error: ${report.reportOnFatalError}`);
@@ -2717,13 +2599,11 @@ console.log(`Report on fatal error: ${report.reportOnFatalError}`);
If `true`, a diagnostic report is generated when the process receives the
signal specified by `process.report.signal`.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report on signal: ${report.reportOnSignal}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report on signal: ${report.reportOnSignal}`);
@@ -2737,13 +2617,11 @@ console.log(`Report on signal: ${report.reportOnSignal}`);
If `true`, a diagnostic report is generated on uncaught exception.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report on exception: ${report.reportOnUncaughtException}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report on exception: ${report.reportOnUncaughtException}`);
@@ -2758,13 +2636,11 @@ console.log(`Report on exception: ${report.reportOnUncaughtException}`);
The signal used to trigger the creation of a diagnostic report. Defaults to
`'SIGUSR2'`.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
console.log(`Report signal: ${report.signal}`);
-```
-
-```cjs
+--------------
const { report } = require('node:process');
console.log(`Report signal: ${report.signal}`);
@@ -2790,13 +2666,11 @@ JavaScript stack trace is taken from `err`, if present.
If the value of `filename` is set to `'stdout'` or `'stderr'`, the report is
written to the stdout or stderr of the process respectively.
-```mjs
+```mjs|cjs
import { report } from 'node:process';
report.writeReport();
-```
-
-```cjs
+--------------
const { report } = require('node:process');
report.writeReport();
@@ -2851,7 +2725,7 @@ Additional documentation is available in the [report documentation][].
process becoming runnable or because the current process exceeded its
time slice. This field is not supported on Windows.
-```mjs
+```mjs|cjs
import { resourceUsage } from 'node:process';
console.log(resourceUsage());
@@ -2876,9 +2750,7 @@ console.log(resourceUsage());
involuntaryContextSwitches: 1
}
*/
-```
-
-```cjs
+--------------
const { resourceUsage } = require('node:process');
console.log(resourceUsage());
@@ -2940,7 +2812,7 @@ The `process.setegid()` method sets the effective group identity of the process.
name string. If a group name is specified, this method blocks while resolving
the associated a numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getegid && process.setegid) {
@@ -2952,9 +2824,7 @@ if (process.getegid && process.setegid) {
console.error(`Failed to set gid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getegid && process.setegid) {
@@ -2983,7 +2853,7 @@ The `process.seteuid()` method sets the effective user identity of the process.
string. If a username is specified, the method blocks while resolving the
associated numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.geteuid && process.seteuid) {
@@ -2995,9 +2865,7 @@ if (process.geteuid && process.seteuid) {
console.error(`Failed to set uid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.geteuid && process.seteuid) {
@@ -3026,7 +2894,7 @@ setgid(2).) The `id` can be passed as either a numeric ID or a group name
string. If a group name is specified, this method blocks while resolving the
associated numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgid && process.setgid) {
@@ -3038,9 +2906,7 @@ if (process.getgid && process.setgid) {
console.error(`Failed to set gid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgid && process.setgid) {
@@ -3070,7 +2936,7 @@ process to have `root` or the `CAP_SETGID` capability.
The `groups` array can contain numeric group IDs, group names, or both.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getgroups && process.setgroups) {
@@ -3081,9 +2947,7 @@ if (process.getgroups && process.setgroups) {
console.error(`Failed to set groups: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getgroups && process.setgroups) {
@@ -3111,7 +2975,7 @@ setuid(2).) The `id` can be passed as either a numeric ID or a username string.
If a username is specified, the method blocks while resolving the associated
numeric ID.
-```mjs
+```mjs|cjs
import process from 'node:process';
if (process.getuid && process.setuid) {
@@ -3123,9 +2987,7 @@ if (process.getuid && process.setuid) {
console.error(`Failed to set uid: ${err}`);
}
}
-```
-
-```cjs
+--------------
const process = require('node:process');
if (process.getuid && process.setuid) {
@@ -3246,13 +3108,11 @@ a [Writable][] stream.
For example, to copy `process.stdin` to `process.stdout`:
-```mjs
+```mjs|cjs
import { stdin, stdout } from 'node:process';
stdin.pipe(stdout);
-```
-
-```cjs
+--------------
const { stdin, stdout } = require('node:process');
stdin.pipe(stdout);
@@ -3403,7 +3263,7 @@ processes inherit the mask from the parent process.
`process.umask(mask)` sets the Node.js process's file mode creation mask. Child
processes inherit the mask from the parent process. Returns the previous mask.
-```mjs
+```mjs|cjs
import { umask } from 'node:process';
const newmask = 0o022;
@@ -3411,9 +3271,7 @@ const oldmask = umask(newmask);
console.log(
`Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`,
);
-```
-
-```cjs
+--------------
const { umask } = require('node:process');
const newmask = 0o022;
@@ -3445,14 +3303,12 @@ seconds.
The `process.version` property contains the Node.js version string.
-```mjs
+```mjs|cjs
import { version } from 'node:process';
console.log(`Version: ${version}`);
// Version: v14.8.0
-```
-
-```cjs
+--------------
const { version } = require('node:process');
console.log(`Version: ${version}`);
@@ -3473,13 +3329,11 @@ Node.js and its dependencies. `process.versions.modules` indicates the current
ABI version, which is increased whenever a C++ API changes. Node.js will refuse
to load modules that were compiled against a different module ABI version.
-```mjs
+```mjs|cjs
import { versions } from 'node:process';
console.log(versions);
-```
-
-```cjs
+--------------
const { versions } = require('node:process');
console.log(versions);
diff --git a/content/api/v19/punycode.en.md b/content/api/v19/punycode.en.md
index 086fefbc88..840ff3b00e 100644
--- a/content/api/v19/punycode.en.md
+++ b/content/api/v19/punycode.en.md
@@ -15,7 +15,7 @@ Deprecated
-
@@ -2575,7 +2563,8 @@ const server = http.createServer((req, res) => {
-* `streams` Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]
+* `streams` Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]|
+ ReadableStream\[]|WritableStream\[]|TransformStream\[]
* Returns: [`stream.Duplex`](/api/v19/stream#streamduplex)
Combines two or more streams into a `Duplex` stream that writes to the
@@ -2780,8 +2769,14 @@ Experimental
* `streamReadable` [`stream.Readable`](/api/v19/stream#streamreadable)
* `options` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
* `strategy` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- * `highWaterMark` [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
- * `size` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
+ * `highWaterMark` [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) The maximum internal queue size (of the created
+ `ReadableStream`) before backpressure is applied in reading from the given
+ `stream.Readable`. If no value is provided, it will be taken from the
+ given `stream.Readable`.
+ * `size` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) A function that size of the given chunk of data.
+ If no value is provided, the size will be `1` for all the chunks.
+ * `chunk` [`any`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types)
+ * Returns: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
* Returns: [`ReadableStream`](/api/v19/webstreams#readablestream)
####
Experimental
-'` if `fn`
- does not have a name.
-* `options` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) Configuration options for the suite.
- supports the same options as `test([name][, options][, fn])`.
-* `fn` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) | [`AsyncFunction`](https://tc39.es/ecma262/#sec-async-function-constructor) The function under test.
- If the test uses callbacks, the callback function is passed as an argument.
- **Default:** A no-op function.
-* Returns: `undefined`.
+
#include
napi_value result;
@@ -2077,9 +2051,7 @@ static napi_value MyNapi(napi_env env, napi_callback_info info) {
...
DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
...
-```
-
-```js
+--------------
const native = require('napi_addon.node');
const data = native.myNapi();
util.types.isExternal(data); // returns true
diff --git a/content/api/v19/v8.en.md b/content/api/v19/v8.en.md
index f17460790a..1de3c2d053 100644
--- a/content/api/v19/v8.en.md
+++ b/content/api/v19/v8.en.md
@@ -7,7 +7,7 @@ version: 'v19'
+
+namespace demo {
+
+using v8::FunctionCallbackInfo;
+using v8::Isolate;
+using v8::Local;
+using v8::Object;
+using v8::String;
+using v8::Value;
+
+void Method(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+ args.GetReturnValue().Set(String::NewFromUtf8(
+ isolate, "world").ToLocalChecked());
+}
+
+void Initialize(Local exports) {
+ NODE_SET_METHOD(exports, "hello", Method);
+}
+
+NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)
+
+} // namespace demo
+```
+
+All Node.js addons must export an initialization function following
+the pattern:
+
+```cpp
+void Initialize(Local exports);
+NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)
+```
+
+There is no semi-colon after `NODE_MODULE` as it's not a function (see
+`node.h`).
+
+The `module_name` must match the filename of the final binary (excluding
+the `.node` suffix).
+
+In the `hello.cc` example, then, the initialization function is `Initialize`
+and the addon module name is `addon`.
+
+When building addons with `node-gyp`, using the macro `NODE_GYP_MODULE_NAME` as
+the first parameter of `NODE_MODULE()` will ensure that the name of the final
+binary will be passed to `NODE_MODULE()`.
+
+Addons defined with `NODE_MODULE()` can not be loaded in multiple contexts or
+multiple threads at the same time.
+
+#### Context-aware addons
+
+There are environments in which Node.js addons may need to be loaded multiple
+times in multiple contexts. For example, the [Electron][] runtime runs multiple
+instances of Node.js in a single process. Each instance will have its own
+`require()` cache, and thus each instance will need a native addon to behave
+correctly when loaded via `require()`. This means that the addon
+must support multiple initializations.
+
+A context-aware addon can be constructed by using the macro
+`NODE_MODULE_INITIALIZER`, which expands to the name of a function which Node.js
+will expect to find when it loads an addon. An addon can thus be initialized as
+in the following example:
+
+```cpp
+using namespace v8;
+
+extern "C" NODE_MODULE_EXPORT void
+NODE_MODULE_INITIALIZER(Local exports,
+ Local module,
+ Local context) {
+ /* Perform addon initialization steps here. */
+}
+```
+
+Another option is to use the macro `NODE_MODULE_INIT()`, which will also
+construct a context-aware addon. Unlike `NODE_MODULE()`, which is used to
+construct an addon around a given addon initializer function,
+`NODE_MODULE_INIT()` serves as the declaration of such an initializer to be
+followed by a function body.
+
+The following three variables may be used inside the function body following an
+invocation of `NODE_MODULE_INIT()`:
+
+* `Local exports`,
+* `Local module`, and
+* `Local context`
+
+The choice to build a context-aware addon carries with it the responsibility of
+carefully managing global static data. Since the addon may be loaded multiple
+times, potentially even from different threads, any global static data stored
+in the addon must be properly protected, and must not contain any persistent
+references to JavaScript objects. The reason for this is that JavaScript
+objects are only valid in one context, and will likely cause a crash when
+accessed from the wrong context or from a different thread than the one on which
+they were created.
+
+The context-aware addon can be structured to avoid global static data by
+performing the following steps:
+
+* Define a class which will hold per-addon-instance data and which has a static
+ member of the form
+ ```cpp
+ static void DeleteInstance(void* data) {
+ // Cast `data` to an instance of the class and delete it.
+ }
+ ```
+* Heap-allocate an instance of this class in the addon initializer. This can be
+ accomplished using the `new` keyword.
+* Call `node::AddEnvironmentCleanupHook()`, passing it the above-created
+ instance and a pointer to `DeleteInstance()`. This will ensure the instance is
+ deleted when the environment is torn down.
+* Store the instance of the class in a `v8::External`, and
+* Pass the `v8::External` to all methods exposed to JavaScript by passing it
+ to `v8::FunctionTemplate::New()` or `v8::Function::New()` which creates the
+ native-backed JavaScript functions. The third parameter of
+ `v8::FunctionTemplate::New()` or `v8::Function::New()` accepts the
+ `v8::External` and makes it available in the native callback using the
+ `v8::FunctionCallbackInfo::Data()` method.
+
+This will ensure that the per-addon-instance data reaches each binding that can
+be called from JavaScript. The per-addon-instance data must also be passed into
+any asynchronous callbacks the addon may create.
+
+The following example illustrates the implementation of a context-aware addon:
+
+```cpp
+#include
+
+using namespace v8;
+
+class AddonData {
+ public:
+ explicit AddonData(Isolate* isolate):
+ call_count(0) {
+ // Ensure this per-addon-instance data is deleted at environment cleanup.
+ node::AddEnvironmentCleanupHook(isolate, DeleteInstance, this);
+ }
+
+ // Per-addon data.
+ int call_count;
+
+ static void DeleteInstance(void* data) {
+ delete static_cast(data);
+ }
+};
+
+static void Method(const v8::FunctionCallbackInfo& info) {
+ // Retrieve the per-addon-instance data.
+ AddonData* data =
+ reinterpret_cast(info.Data().As()->Value());
+ data->call_count++;
+ info.GetReturnValue().Set((double)data->call_count);
+}
+
+// Initialize this addon to be context-aware.
+NODE_MODULE_INIT(/* exports, module, context */) {
+ Isolate* isolate = context->GetIsolate();
+
+ // Create a new instance of `AddonData` for this instance of the addon and
+ // tie its life cycle to that of the Node.js environment.
+ AddonData* data = new AddonData(isolate);
+
+ // Wrap the data in a `v8::External` so we can pass it to the method we
+ // expose.
+ Local external = External::New(isolate, data);
+
+ // Expose the method `Method` to JavaScript, and make sure it receives the
+ // per-addon-instance data we created above by passing `external` as the
+ // third parameter to the `FunctionTemplate` constructor.
+ exports->Set(context,
+ String::NewFromUtf8(isolate, "method").ToLocalChecked(),
+ FunctionTemplate::New(isolate, Method, external)
+ ->GetFunction(context).ToLocalChecked()).FromJust();
+}
+```
+
+##### Worker support
+
+
+#include
+#include
+
+using node::AddEnvironmentCleanupHook;
+using v8::HandleScope;
+using v8::Isolate;
+using v8::Local;
+using v8::Object;
+
+// Note: In a real-world application, do not rely on static/global data.
+static char cookie[] = "yum yum";
+static int cleanup_cb1_called = 0;
+static int cleanup_cb2_called = 0;
+
+static void cleanup_cb1(void* arg) {
+ Isolate* isolate = static_cast(arg);
+ HandleScope scope(isolate);
+ Local obj = Object::New(isolate);
+ assert(!obj.IsEmpty()); // assert VM is still alive
+ assert(obj->IsObject());
+ cleanup_cb1_called++;
+}
+
+static void cleanup_cb2(void* arg) {
+ assert(arg == static_cast(cookie));
+ cleanup_cb2_called++;
+}
+
+static void sanity_check(void*) {
+ assert(cleanup_cb1_called == 1);
+ assert(cleanup_cb2_called == 1);
+}
+
+// Initialize this addon to be context-aware.
+NODE_MODULE_INIT(/* exports, module, context */) {
+ Isolate* isolate = context->GetIsolate();
+
+ AddEnvironmentCleanupHook(isolate, sanity_check, nullptr);
+ AddEnvironmentCleanupHook(isolate, cleanup_cb2, cookie);
+ AddEnvironmentCleanupHook(isolate, cleanup_cb1, isolate);
+}
+```
+
+Test in JavaScript by running:
+
+```js
+// test.js
+require('./build/Release/addon');
+```
+
+#### Building
+
+Once the source code has been written, it must be compiled into the binary
+`addon.node` file. To do so, create a file called `binding.gyp` in the
+top-level of the project describing the build configuration of the module
+using a JSON-like format. This file is used by [node-gyp][], a tool written
+specifically to compile Node.js addons.
+
+```json
+{
+ "targets": [
+ {
+ "target_name": "addon",
+ "sources": [ "hello.cc" ]
+ }
+ ]
+}
+```
+
+A version of the `node-gyp` utility is bundled and distributed with
+Node.js as part of `npm`. This version is not made directly available for
+developers to use and is intended only to support the ability to use the
+`npm install` command to compile and install addons. Developers who wish to
+use `node-gyp` directly can install it using the command
+`npm install -g node-gyp`. See the `node-gyp` [installation instructions][] for
+more information, including platform-specific requirements.
+
+Once the `binding.gyp` file has been created, use `node-gyp configure` to
+generate the appropriate project build files for the current platform. This
+will generate either a `Makefile` (on Unix platforms) or a `vcxproj` file
+(on Windows) in the `build/` directory.
+
+Next, invoke the `node-gyp build` command to generate the compiled `addon.node`
+file. This will be put into the `build/Release/` directory.
+
+When using `npm install` to install a Node.js addon, npm uses its own bundled
+version of `node-gyp` to perform this same set of actions, generating a
+compiled version of the addon for the user's platform on demand.
+
+Once built, the binary addon can be used from within Node.js by pointing
+[`require()`][require] to the built `addon.node` module:
+
+```js
+// hello.js
+const addon = require('./build/Release/addon');
+
+console.log(addon.hello());
+// Prints: 'world'
+```
+
+Because the exact path to the compiled addon binary can vary depending on how
+it is compiled (i.e. sometimes it may be in `./build/Debug/`), addons can use
+the [bindings][] package to load the compiled module.
+
+While the `bindings` package implementation is more sophisticated in how it
+locates addon modules, it is essentially using a `try…catch` pattern similar to:
+
+```js
+try {
+ return require('./build/Release/addon.node');
+} catch (err) {
+ return require('./build/Debug/addon.node');
+}
+```
+
+#### Linking to libraries included with Node.js
+
+Node.js uses statically linked libraries such as V8, libuv, and OpenSSL. All
+addons are required to link to V8 and may link to any of the other dependencies
+as well. Typically, this is as simple as including the appropriate
+`#include <...>` statements (e.g. `#include `) and `node-gyp` will locate
+the appropriate headers automatically. However, there are a few caveats to be
+aware of:
+
+* When `node-gyp` runs, it will detect the specific release version of Node.js
+ and download either the full source tarball or just the headers. If the full
+ source is downloaded, addons will have complete access to the full set of
+ Node.js dependencies. However, if only the Node.js headers are downloaded,
+ then only the symbols exported by Node.js will be available.
+
+* `node-gyp` can be run using the `--nodedir` flag pointing at a local Node.js
+ source image. Using this option, the addon will have access to the full set of
+ dependencies.
+
+#### Loading addons using `require()`
+
+The filename extension of the compiled addon binary is `.node` (as opposed
+to `.dll` or `.so`). The [`require()`][require] function is written to look for
+files with the `.node` file extension and initialize those as dynamically-linked
+libraries.
+
+When calling [`require()`][require], the `.node` extension can usually be
+omitted and Node.js will still find and initialize the addon. One caveat,
+however, is that Node.js will first attempt to locate and load modules or
+JavaScript files that happen to share the same base name. For instance, if
+there is a file `addon.js` in the same directory as the binary `addon.node`,
+then [`require('addon')`][require] will give precedence to the `addon.js` file
+and load it instead.
+
+### Native abstractions for Node.js
+
+Each of the examples illustrated in this document directly use the
+Node.js and V8 APIs for implementing addons. The V8 API can, and has, changed
+dramatically from one V8 release to the next (and one major Node.js release to
+the next). With each change, addons may need to be updated and recompiled in
+order to continue functioning. The Node.js release schedule is designed to
+minimize the frequency and impact of such changes but there is little that
+Node.js can do to ensure stability of the V8 APIs.
+
+The [Native Abstractions for Node.js][] (or `nan`) provide a set of tools that
+addon developers are recommended to use to keep compatibility between past and
+future releases of V8 and Node.js. See the `nan` [examples][] for an
+illustration of how it can be used.
+
+### Node-API
+
+
+
+Stable
+
+
+
+Node-API is an API for building native addons. It is independent from
+the underlying JavaScript runtime (e.g. V8) and is maintained as part of
+Node.js itself. This API will be Application Binary Interface (ABI) stable
+across versions of Node.js. It is intended to insulate addons from
+changes in the underlying JavaScript engine and allow modules
+compiled for one version to run on later versions of Node.js without
+recompilation. Addons are built/packaged with the same approach/tools
+outlined in this document (node-gyp, etc.). The only difference is the
+set of APIs that are used by the native code. Instead of using the V8
+or [Native Abstractions for Node.js][] APIs, the functions available
+in the Node-API are used.
+
+Creating and maintaining an addon that benefits from the ABI stability
+provided by Node-API carries with it certain
+[implementation considerations][].
+
+To use Node-API in the above "Hello world" example, replace the content of
+`hello.cc` with the following. All other instructions remain the same.
+
+```cpp
+// hello.cc using Node-API
+#include
+
+namespace demo {
+
+napi_value Method(napi_env env, napi_callback_info args) {
+ napi_value greeting;
+ napi_status status;
+
+ status = napi_create_string_utf8(env, "world", NAPI_AUTO_LENGTH, &greeting);
+ if (status != napi_ok) return nullptr;
+ return greeting;
+}
+
+napi_value init(napi_env env, napi_value exports) {
+ napi_status status;
+ napi_value fn;
+
+ status = napi_create_function(env, nullptr, 0, Method, nullptr, &fn);
+ if (status != napi_ok) return nullptr;
+
+ status = napi_set_named_property(env, exports, "hello", fn);
+ if (status != napi_ok) return nullptr;
+ return exports;
+}
+
+NAPI_MODULE(NODE_GYP_MODULE_NAME, init)
+
+} // namespace demo
+```
+
+The functions available and how to use them are documented in
+[C/C++ addons with Node-API](n-api.md).
+
+### Addon examples
+
+Following are some example addons intended to help developers get started. The
+examples use the V8 APIs. Refer to the online [V8 reference][v8-docs]
+for help with the various V8 calls, and V8's [Embedder's Guide][] for an
+explanation of several concepts used such as handles, scopes, function
+templates, etc.
+
+Each of these examples using the following `binding.gyp` file:
+
+```json
+{
+ "targets": [
+ {
+ "target_name": "addon",
+ "sources": [ "addon.cc" ]
+ }
+ ]
+}
+```
+
+In cases where there is more than one `.cc` file, simply add the additional
+filename to the `sources` array:
+
+```json
+"sources": ["addon.cc", "myexample.cc"]
+```
+
+Once the `binding.gyp` file is ready, the example addons can be configured and
+built using `node-gyp`:
+
+```bash
+node-gyp configure build
+```
+
+#### Function arguments
+
+Addons will typically expose objects and functions that can be accessed from
+JavaScript running within Node.js. When functions are invoked from JavaScript,
+the input arguments and return value must be mapped to and from the C/C++
+code.
+
+The following example illustrates how to read function arguments passed from
+JavaScript and how to return a result:
+
+```cpp
+// addon.cc
+#include
+
+namespace demo {
+
+using v8::Exception;
+using v8::FunctionCallbackInfo;
+using v8::Isolate;
+using v8::Local;
+using v8::Number;
+using v8::Object;
+using v8::String;
+using v8::Value;
+
+// This is the implementation of the "add" method
+// Input arguments are passed using the
+// const FunctionCallbackInfo& args struct
+void Add(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+
+ // Check the number of arguments passed.
+ if (args.Length() < 2) {
+ // Throw an Error that is passed back to JavaScript
+ isolate->ThrowException(Exception::TypeError(
+ String::NewFromUtf8(isolate,
+ "Wrong number of arguments").ToLocalChecked()));
+ return;
+ }
+
+ // Check the argument types
+ if (!args[0]->IsNumber() || !args[1]->IsNumber()) {
+ isolate->ThrowException(Exception::TypeError(
+ String::NewFromUtf8(isolate,
+ "Wrong arguments").ToLocalChecked()));
+ return;
+ }
+
+ // Perform the operation
+ double value =
+ args[0].As()->Value() + args[1].As()->Value();
+ Local num = Number::New(isolate, value);
+
+ // Set the return value (using the passed in
+ // FunctionCallbackInfo&)
+ args.GetReturnValue().Set(num);
+}
+
+void Init(Local exports) {
+ NODE_SET_METHOD(exports, "add", Add);
+}
+
+NODE_MODULE(NODE_GYP_MODULE_NAME, Init)
+
+} // namespace demo
+```
+
+Once compiled, the example addon can be required and used from within Node.js:
+
+```js
+// test.js
+const addon = require('./build/Release/addon');
+
+console.log('This should be eight:', addon.add(3, 5));
+```
+
+#### Callbacks
+
+It is common practice within addons to pass JavaScript functions to a C++
+function and execute them from there. The following example illustrates how
+to invoke such callbacks:
+
+```cpp
+// addon.cc
+#include
+
+namespace demo {
+
+using v8::Context;
+using v8::Function;
+using v8::FunctionCallbackInfo;
+using v8::Isolate;
+using v8::Local;
+using v8::Null;
+using v8::Object;
+using v8::String;
+using v8::Value;
+
+void RunCallback(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+ Local context = isolate->GetCurrentContext();
+ Local cb = Local::Cast(args[0]);
+ const unsigned argc = 1;
+ Local argv[argc] = {
+ String::NewFromUtf8(isolate,
+ "hello world").ToLocalChecked() };
+ cb->Call(context, Null(isolate), argc, argv).ToLocalChecked();
+}
+
+void Init(Local exports, Local module) {
+ NODE_SET_METHOD(module, "exports", RunCallback);
+}
+
+NODE_MODULE(NODE_GYP_MODULE_NAME, Init)
+
+} // namespace demo
+```
+
+This example uses a two-argument form of `Init()` that receives the full
+`module` object as the second argument. This allows the addon to completely
+overwrite `exports` with a single function instead of adding the function as a
+property of `exports`.
+
+To test it, run the following JavaScript:
+
+```js
+// test.js
+const addon = require('./build/Release/addon');
+
+addon((msg) => {
+ console.log(msg);
+// Prints: 'hello world'
+});
+```
+
+In this example, the callback function is invoked synchronously.
+
+#### Object factory
+
+Addons can create and return new objects from within a C++ function as
+illustrated in the following example. An object is created and returned with a
+property `msg` that echoes the string passed to `createObject()`:
+
+```cpp
+// addon.cc
+#include
+
+namespace demo {
+
+using v8::Context;
+using v8::FunctionCallbackInfo;
+using v8::Isolate;
+using v8::Local;
+using v8::Object;
+using v8::String;
+using v8::Value;
+
+void CreateObject(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+ Local context = isolate->GetCurrentContext();
+
+ Local obj = Object::New(isolate);
+ obj->Set(context,
+ String::NewFromUtf8(isolate,
+ "msg").ToLocalChecked(),
+ args[0]->ToString(context).ToLocalChecked())
+ .FromJust();
+
+ args.GetReturnValue().Set(obj);
+}
+
+void Init(Local exports, Local module) {
+ NODE_SET_METHOD(module, "exports", CreateObject);
+}
+
+NODE_MODULE(NODE_GYP_MODULE_NAME, Init)
+
+} // namespace demo
+```
+
+To test it in JavaScript:
+
+```js
+// test.js
+const addon = require('./build/Release/addon');
+
+const obj1 = addon('hello');
+const obj2 = addon('world');
+console.log(obj1.msg, obj2.msg);
+// Prints: 'hello world'
+```
+
+#### Function factory
+
+Another common scenario is creating JavaScript functions that wrap C++
+functions and returning those back to JavaScript:
+
+```cpp
+// addon.cc
+#include
+
+namespace demo {
+
+using v8::Context;
+using v8::Function;
+using v8::FunctionCallbackInfo;
+using v8::FunctionTemplate;
+using v8::Isolate;
+using v8::Local;
+using v8::Object;
+using v8::String;
+using v8::Value;
+
+void MyFunction(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+ args.GetReturnValue().Set(String::NewFromUtf8(
+ isolate, "hello world").ToLocalChecked());
+}
+
+void CreateFunction(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+
+ Local context = isolate->GetCurrentContext();
+ Local tpl = FunctionTemplate::New(isolate, MyFunction);
+ Local fn = tpl->GetFunction(context).ToLocalChecked();
+
+ // omit this to make it anonymous
+ fn->SetName(String::NewFromUtf8(
+ isolate, "theFunction").ToLocalChecked());
+
+ args.GetReturnValue().Set(fn);
+}
+
+void Init(Local exports, Local module) {
+ NODE_SET_METHOD(module, "exports", CreateFunction);
+}
+
+NODE_MODULE(NODE_GYP_MODULE_NAME, Init)
+
+} // namespace demo
+```
+
+To test:
+
+```js
+// test.js
+const addon = require('./build/Release/addon');
+
+const fn = addon();
+console.log(fn());
+// Prints: 'hello world'
+```
+
+#### Wrapping C++ objects
+
+It is also possible to wrap C++ objects/classes in a way that allows new
+instances to be created using the JavaScript `new` operator:
+
+```cpp
+// addon.cc
+#include
+#include "myobject.h"
+
+namespace demo {
+
+using v8::Local;
+using v8::Object;
+
+void InitAll(Local exports) {
+ MyObject::Init(exports);
+}
+
+NODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)
+
+} // namespace demo
+```
+
+Then, in `myobject.h`, the wrapper class inherits from `node::ObjectWrap`:
+
+```cpp
+// myobject.h
+#ifndef MYOBJECT_H
+#define MYOBJECT_H
+
+#include
+#include
+
+namespace demo {
+
+class MyObject : public node::ObjectWrap {
+ public:
+ static void Init(v8::Local exports);
+
+ private:
+ explicit MyObject(double value = 0);
+ ~MyObject();
+
+ static void New(const v8::FunctionCallbackInfo& args);
+ static void PlusOne(const v8::FunctionCallbackInfo& args);
+
+ double value_;
+};
+
+} // namespace demo
+
+#endif
+```
+
+In `myobject.cc`, implement the various methods that are to be exposed.
+Below, the method `plusOne()` is exposed by adding it to the constructor's
+prototype:
+
+```cpp
+// myobject.cc
+#include "myobject.h"
+
+namespace demo {
+
+using v8::Context;
+using v8::Function;
+using v8::FunctionCallbackInfo;
+using v8::FunctionTemplate;
+using v8::Isolate;
+using v8::Local;
+using v8::Number;
+using v8::Object;
+using v8::ObjectTemplate;
+using v8::String;
+using v8::Value;
+
+MyObject::MyObject(double value) : value_(value) {
+}
+
+MyObject::~MyObject() {
+}
+
+void MyObject::Init(Local exports) {
+ Isolate* isolate = exports->GetIsolate();
+ Local context = isolate->GetCurrentContext();
+
+ Local addon_data_tpl = ObjectTemplate::New(isolate);
+ addon_data_tpl->SetInternalFieldCount(1); // 1 field for the MyObject::New()
+ Local addon_data =
+ addon_data_tpl->NewInstance(context).ToLocalChecked();
+
+ // Prepare constructor template
+ Local tpl = FunctionTemplate::New(isolate, New, addon_data);
+ tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject").ToLocalChecked());
+ tpl->InstanceTemplate()->SetInternalFieldCount(1);
+
+ // Prototype
+ NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);
+
+ Local constructor = tpl->GetFunction(context).ToLocalChecked();
+ addon_data->SetInternalField(0, constructor);
+ exports->Set(context, String::NewFromUtf8(
+ isolate, "MyObject").ToLocalChecked(),
+ constructor).FromJust();
+}
+
+void MyObject::New(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+ Local context = isolate->GetCurrentContext();
+
+ if (args.IsConstructCall()) {
+ // Invoked as constructor: `new MyObject(...)`
+ double value = args[0]->IsUndefined() ?
+ 0 : args[0]->NumberValue(context).FromMaybe(0);
+ MyObject* obj = new MyObject(value);
+ obj->Wrap(args.This());
+ args.GetReturnValue().Set(args.This());
+ } else {
+ // Invoked as plain function `MyObject(...)`, turn into construct call.
+ const int argc = 1;
+ Local argv[argc] = { args[0] };
+ Local cons =
+ args.Data().As()->GetInternalField(0).As();
+ Local result =
+ cons->NewInstance(context, argc, argv).ToLocalChecked();
+ args.GetReturnValue().Set(result);
+ }
+}
+
+void MyObject::PlusOne(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+
+ MyObject* obj = ObjectWrap::Unwrap(args.Holder());
+ obj->value_ += 1;
+
+ args.GetReturnValue().Set(Number::New(isolate, obj->value_));
+}
+
+} // namespace demo
+```
+
+To build this example, the `myobject.cc` file must be added to the
+`binding.gyp`:
+
+```json
+{
+ "targets": [
+ {
+ "target_name": "addon",
+ "sources": [
+ "addon.cc",
+ "myobject.cc"
+ ]
+ }
+ ]
+}
+```
+
+Test it with:
+
+```js
+// test.js
+const addon = require('./build/Release/addon');
+
+const obj = new addon.MyObject(10);
+console.log(obj.plusOne());
+// Prints: 11
+console.log(obj.plusOne());
+// Prints: 12
+console.log(obj.plusOne());
+// Prints: 13
+```
+
+The destructor for a wrapper object will run when the object is
+garbage-collected. For destructor testing, there are command-line flags that
+can be used to make it possible to force garbage collection. These flags are
+provided by the underlying V8 JavaScript engine. They are subject to change
+or removal at any time. They are not documented by Node.js or V8, and they
+should never be used outside of testing.
+
+During shutdown of the process or worker threads destructors are not called
+by the JS engine. Therefore it's the responsibility of the user to track
+these objects and ensure proper destruction to avoid resource leaks.
+
+#### Factory of wrapped objects
+
+Alternatively, it is possible to use a factory pattern to avoid explicitly
+creating object instances using the JavaScript `new` operator:
+
+```js
+const obj = addon.createObject();
+// instead of:
+// const obj = new addon.Object();
+```
+
+First, the `createObject()` method is implemented in `addon.cc`:
+
+```cpp
+// addon.cc
+#include
+#include "myobject.h"
+
+namespace demo {
+
+using v8::FunctionCallbackInfo;
+using v8::Isolate;
+using v8::Local;
+using v8::Object;
+using v8::String;
+using v8::Value;
+
+void CreateObject(const FunctionCallbackInfo& args) {
+ MyObject::NewInstance(args);
+}
+
+void InitAll(Local exports, Local module) {
+ MyObject::Init(exports->GetIsolate());
+
+ NODE_SET_METHOD(module, "exports", CreateObject);
+}
+
+NODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)
+
+} // namespace demo
+```
+
+In `myobject.h`, the static method `NewInstance()` is added to handle
+instantiating the object. This method takes the place of using `new` in
+JavaScript:
+
+```cpp
+// myobject.h
+#ifndef MYOBJECT_H
+#define MYOBJECT_H
+
+#include
+#include
+
+namespace demo {
+
+class MyObject : public node::ObjectWrap {
+ public:
+ static void Init(v8::Isolate* isolate);
+ static void NewInstance(const v8::FunctionCallbackInfo& args);
+
+ private:
+ explicit MyObject(double value = 0);
+ ~MyObject();
+
+ static void New(const v8::FunctionCallbackInfo& args);
+ static void PlusOne(const v8::FunctionCallbackInfo& args);
+ static v8::Global constructor;
+ double value_;
+};
+
+} // namespace demo
+
+#endif
+```
+
+The implementation in `myobject.cc` is similar to the previous example:
+
+```cpp
+// myobject.cc
+#include
+#include "myobject.h"
+
+namespace demo {
+
+using node::AddEnvironmentCleanupHook;
+using v8::Context;
+using v8::Function;
+using v8::FunctionCallbackInfo;
+using v8::FunctionTemplate;
+using v8::Global;
+using v8::Isolate;
+using v8::Local;
+using v8::Number;
+using v8::Object;
+using v8::String;
+using v8::Value;
+
+// Warning! This is not thread-safe, this addon cannot be used for worker
+// threads.
+Global MyObject::constructor;
+
+MyObject::MyObject(double value) : value_(value) {
+}
+
+MyObject::~MyObject() {
+}
+
+void MyObject::Init(Isolate* isolate) {
+ // Prepare constructor template
+ Local tpl = FunctionTemplate::New(isolate, New);
+ tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject").ToLocalChecked());
+ tpl->InstanceTemplate()->SetInternalFieldCount(1);
+
+ // Prototype
+ NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);
+
+ Local context = isolate->GetCurrentContext();
+ constructor.Reset(isolate, tpl->GetFunction(context).ToLocalChecked());
+
+ AddEnvironmentCleanupHook(isolate, [](void*) {
+ constructor.Reset();
+ }, nullptr);
+}
+
+void MyObject::New(const FunctionCallbackInfo& args) {
+ Isolate* isolate = args.GetIsolate();
+ Local context = isolate->GetCurrentContext();
+
+ if (args.IsConstructCall()) {
+ // Invoked as constructor: `new MyObject(...)`
+ double value = args[0]->IsUndefined() ?
+ 0 : args[0]->NumberValue(context).FromMaybe(0);
+ MyObject* obj = new MyObject(value);
+ obj->Wrap(args.This());
+ args.GetReturnValue().Set(args.This());
+ } else {
+ // Invoked as plain function `MyObject(...)`, turn into construct call.
+ const int argc = 1;
+ Local argv[argc] = { args[0] };
+ Local cons = Local::New(isolate, constructor);
+ Local instance =
+ cons->NewInstance(context, argc, argv).ToLocalChecked();
+ args.GetReturnValue().Set(instance);
+ }
+}
+
+void MyObject::NewInstance(const FunctionCallbackInfo 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
