Skip to content

Commit

Permalink
doc: add node: prefix for all core modules
Browse files Browse the repository at this point in the history
Some core modules can be loaded with or without the `node:` prefix.
Using the prefix disambiguates which specifiers refer to core modules.

This commit updates the docs to use the prefix everywhere a core module
is referenced.

PR-URL: #42752
Fixes: #38343
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
  • Loading branch information
aduh95 authored and targos committed Jul 31, 2022
1 parent 29976a3 commit cc398a8
Show file tree
Hide file tree
Showing 58 changed files with 1,640 additions and 1,632 deletions.
166 changes: 83 additions & 83 deletions doc/api/assert.md

Large diffs are not rendered by default.

58 changes: 29 additions & 29 deletions doc/api/async_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ or any other asynchronous duration. It is similar to thread-local storage
in other languages.

The `AsyncLocalStorage` and `AsyncResource` classes are part of the
`async_hooks` module:
`node:async_hooks` module:

```mjs
import { AsyncLocalStorage, AsyncResource } from 'async_hooks';
import { AsyncLocalStorage, AsyncResource } from 'node:async_hooks';
```

```cjs
const { AsyncLocalStorage, AsyncResource } = require('async_hooks');
const { AsyncLocalStorage, AsyncResource } = require('node:async_hooks');
```

## Class: `AsyncLocalStorage`
Expand All @@ -39,18 +39,18 @@ changes:

This class creates stores that stay coherent through asynchronous operations.

While you can create your own implementation on top of the `async_hooks` module,
`AsyncLocalStorage` should be preferred as it is a performant and memory safe
implementation that involves significant optimizations that are non-obvious to
implement.
While you can create your own implementation on top of the `node:async_hooks`
module, `AsyncLocalStorage` should be preferred as it is a performant and memory
safe implementation that involves significant optimizations that are non-obvious
to implement.

The following example uses `AsyncLocalStorage` to build a simple logger
that assigns IDs to incoming HTTP requests and includes them in messages
logged within each request.

```mjs
import http from 'http';
import { AsyncLocalStorage } from 'async_hooks';
import http from 'node:http';
import { AsyncLocalStorage } from 'node:async_hooks';

const asyncLocalStorage = new AsyncLocalStorage();

Expand Down Expand Up @@ -81,8 +81,8 @@ http.get('http://localhost:8080');
```

```cjs
const http = require('http');
const { AsyncLocalStorage } = require('async_hooks');
const http = require('node:http');
const { AsyncLocalStorage } = require('node:async_hooks');

const asyncLocalStorage = new AsyncLocalStorage();

Expand Down Expand Up @@ -348,7 +348,7 @@ The `init` hook will trigger when an `AsyncResource` is instantiated.
The following is an overview of the `AsyncResource` API.

```mjs
import { AsyncResource, executionAsyncId } from 'async_hooks';
import { AsyncResource, executionAsyncId } from 'node:async_hooks';

// AsyncResource() is meant to be extended. Instantiating a
// new AsyncResource() also triggers init. If triggerAsyncId is omitted then
Expand Down Expand Up @@ -376,7 +376,7 @@ asyncResource.triggerAsyncId();
```

```cjs
const { AsyncResource, executionAsyncId } = require('async_hooks');
const { AsyncResource, executionAsyncId } = require('node:async_hooks');

// AsyncResource() is meant to be extended. Instantiating a
// new AsyncResource() also triggers init. If triggerAsyncId is omitted then
Expand Down Expand Up @@ -535,14 +535,14 @@ Assuming that the task is adding two numbers, using a file named
`task_processor.js` with the following content:

```mjs
import { parentPort } from 'worker_threads';
import { parentPort } from 'node:worker_threads';
parentPort.on('message', (task) => {
parentPort.postMessage(task.a + task.b);
});
```

```cjs
const { parentPort } = require('worker_threads');
const { parentPort } = require('node:worker_threads');
parentPort.on('message', (task) => {
parentPort.postMessage(task.a + task.b);
});
Expand All @@ -551,10 +551,10 @@ parentPort.on('message', (task) => {
a Worker pool around it could use the following structure:

```mjs
import { AsyncResource } from 'async_hooks';
import { EventEmitter } from 'events';
import path from 'path';
import { Worker } from 'worker_threads';
import { AsyncResource } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import path from 'node:path';
import { Worker } from 'node:worker_threads';

const kTaskInfo = Symbol('kTaskInfo');
const kWorkerFreedEvent = Symbol('kWorkerFreedEvent');
Expand Down Expand Up @@ -639,10 +639,10 @@ export default class WorkerPool extends EventEmitter {
```
```cjs
const { AsyncResource } = require('async_hooks');
const { EventEmitter } = require('events');
const path = require('path');
const { Worker } = require('worker_threads');
const { AsyncResource } = require('node:async_hooks');
const { EventEmitter } = require('node:events');
const path = require('node:path');
const { Worker } = require('node:worker_threads');

const kTaskInfo = Symbol('kTaskInfo');
const kWorkerFreedEvent = Symbol('kWorkerFreedEvent');
Expand Down Expand Up @@ -738,7 +738,7 @@ This pool could be used as follows:
```mjs
import WorkerPool from './worker_pool.js';
import os from 'os';
import os from 'node:os';

const pool = new WorkerPool(os.cpus().length);

Expand All @@ -754,7 +754,7 @@ for (let i = 0; i < 10; i++) {
```cjs
const WorkerPool = require('./worker_pool.js');
const os = require('os');
const os = require('node:os');

const pool = new WorkerPool(os.cpus().length);

Expand All @@ -779,8 +779,8 @@ associate an event listener with the correct execution context. The same
approach can be applied to a [`Stream`][] or a similar event-driven class.
```mjs
import { createServer } from 'http';
import { AsyncResource, executionAsyncId } from 'async_hooks';
import { createServer } from 'node:http';
import { AsyncResource, executionAsyncId } from 'node:async_hooks';

const server = createServer((req, res) => {
req.on('close', AsyncResource.bind(() => {
Expand All @@ -794,8 +794,8 @@ const server = createServer((req, res) => {
```
```cjs
const { createServer } = require('http');
const { AsyncResource, executionAsyncId } = require('async_hooks');
const { createServer } = require('node:http');
const { AsyncResource, executionAsyncId } = require('node:async_hooks');

const server = createServer((req, res) => {
req.on('close', AsyncResource.bind(() => {
Expand Down
Loading

0 comments on commit cc398a8

Please sign in to comment.