FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: fix inconsistencies in CJS code snippets · nodejs/node@e0b1f09 · GitHub

/ node Public

Commit e0b1f09

Browse files
aduh95
committed
doc: fix inconsistencies in CJS code snippets
Signed-off-by: Antoine du Hamel <duhamelantoine1995@gmail.com> PR-URL: #63199 Reviewed-By: Jacob Smith <jacob@frende.me> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
1 parent a3feb15 commit e0b1f09

15 files changed

Lines changed: 11 additions & 137 deletions

‎doc/api/child_process.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,6 @@ the error passed to the callback will be an `AbortError`:
591591

592592
```cjs
593593
const { fork } = require('node:child_process');
594-
const process = require('node:process');
595594

596595
if (process.argv[2] === 'child') {
597596
setTimeout(() => {
@@ -933,7 +932,6 @@ Example of a long-running process, by detaching and also ignoring its parent
933932
934933
```cjs
935934
const { spawn } = require('node:child_process');
936-
const process = require('node:process');
937935

938936
const subprocess = spawn(process.argv[0], ['child_program.js'], {
939937
detached: true,
@@ -1077,7 +1075,6 @@ pipes between the parent and child. The value is one of the following:
10771075
10781076
```cjs
10791077
const { spawn } = require('node:child_process');
1080-
const process = require('node:process');
10811078

10821079
// Child will use parent's stdios.
10831080
spawn('prg', [], { stdio: 'inherit' });
@@ -1833,7 +1830,6 @@ process to wait for the child process to exit before exiting itself.
18331830
18341831
```cjs
18351832
const { spawn } = require('node:child_process');
1836-
const process = require('node:process');
18371833

18381834
const subprocess = spawn(process.argv[0], ['child_program.js'], {
18391835
detached: true,
@@ -2289,7 +2285,6 @@ the child and the parent processes.
22892285

22902286
```cjs
22912287
const { spawn } = require('node:child_process');
2292-
const process = require('node:process');
22932288
22942289
const subprocess = spawn(process.argv[0], ['child_program.js'], {
22952290
detached: true,

‎doc/api/cluster.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ if (cluster.isPrimary) {
4949
const cluster = require('node:cluster');
5050
const http = require('node:http');
5151
const numCPUs = require('node:os').availableParallelism();
52-
const process = require('node:process');
5352

5453
if (cluster.isPrimary) {
5554
console.log(`Primary ${process.pid} is running`);
@@ -318,7 +317,6 @@ if (cluster.isPrimary) {
318317
const cluster = require('node:cluster');
319318
const http = require('node:http');
320319
const numCPUs = require('node:os').availableParallelism();
321-
const process = require('node:process');
322320

323321
if (cluster.isPrimary) {
324322

@@ -541,7 +539,6 @@ if (cluster.isPrimary) {
541539
const cluster = require('node:cluster');
542540
const http = require('node:http');
543541
const numCPUs = require('node:os').availableParallelism();
544-
const process = require('node:process');
545542

546543
if (cluster.isPrimary) {
547544
console.log(`Primary ${process.pid} is running`);

‎doc/api/perf_hooks.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1682,7 +1682,6 @@ setImmediate(() => {
16821682
```
16831683

16841684
```cjs
1685-
'use strict';
16861685
const { eventLoopUtilization } = require('node:perf_hooks');
16871686
const { spawnSync } = require('node:child_process');
16881687

@@ -2132,7 +2131,6 @@ setTimeout(() => {}, 1000);
21322131
```
21332132

21342133
```cjs
2135-
'use strict';
21362134
const async_hooks = require('node:async_hooks');
21372135
const {
21382136
performance,
@@ -2202,7 +2200,6 @@ await timedImport('some-module');
22022200
<!-- eslint-disable no-global-assign -->
22032201

22042202
```cjs
2205-
'use strict';
22062203
const {
22072204
performance,
22082205
PerformanceObserver,
@@ -2259,7 +2256,6 @@ createServer((req, res) => {
22592256
```
22602257

22612258
```cjs
2262-
'use strict';
22632259
const { PerformanceObserver } = require('node:perf_hooks');
22642260
const http = require('node:http');
22652261

@@ -2301,7 +2297,6 @@ createServer((socket) => {
23012297
```
23022298

23032299
```cjs
2304-
'use strict';
23052300
const { PerformanceObserver } = require('node:perf_hooks');
23062301
const net = require('node:net');
23072302
const obs = new PerformanceObserver((items) => {
@@ -2335,7 +2330,6 @@ promises.resolve('localhost');
23352330
```
23362331

23372332
```cjs
2338-
'use strict';
23392333
const { PerformanceObserver } = require('node:perf_hooks');
23402334
const dns = require('node:dns');
23412335
const obs = new PerformanceObserver((items) => {

‎doc/api/process.md‎

Lines changed: 2 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Node.js process.
1313
import process from 'node:process';
1414
```
1515

16+
<!-- eslint-disable no-restricted-syntax -->
17+
1618
```cjs
1719
const process = require('node:process');
1820
```
@@ -62,8 +64,6 @@ console.log('This message is displayed first.');
6264
```
6365

6466
```cjs
65-
const process = require('node:process');
66-
6767
process.on('beforeExit', (code) => {
6868
console.log('Process beforeExit event with code: ', code);
6969
});
@@ -120,8 +120,6 @@ process.on('exit', (code) => {
120120
```
121121

122122
```cjs
123-
const process = require('node:process');
124-
125123
process.on('exit', (code) => {
126124
console.log(`About to exit with code: ${code}`);
127125
});
@@ -143,8 +141,6 @@ process.on('exit', (code) => {
143141
```
144142

145143
```cjs
146-
const process = require('node:process');
147-
148144
process.on('exit', (code) => {
149145
setTimeout(() => {
150146
console.log('This will not run');
@@ -221,8 +217,6 @@ process.on('rejectionHandled', (promise) => {
221217
```
222218

223219
```cjs
224-
const process = require('node:process');
225-
226220
const unhandledRejections = new Map();
227221
process.on('unhandledRejection', (reason, promise) => {
228222
unhandledRejections.set(promise, reason);
@@ -305,7 +299,6 @@ console.log('This will not run.');
305299
```
306300

307301
```cjs
308-
const process = require('node:process');
309302
const fs = require('node:fs');
310303

311304
process.on('uncaughtException', (err, origin) => {
@@ -394,8 +387,6 @@ nonexistentFunc();
394387
```
395388

396389
```cjs
397-
const process = require('node:process');
398-
399390
process.on('uncaughtExceptionMonitor', (err, origin) => {
400391
MyMonitoringTool.logSync(err, origin);
401392
});
@@ -445,8 +436,6 @@ somePromise.then((res) => {
445436
```
446437

447438
```cjs
448-
const process = require('node:process');
449-
450439
process.on('unhandledRejection', (reason, promise) => {
451440
console.log('Unhandled Rejection at:', promise, 'reason:', reason);
452441
// Application specific logging, throwing an error, or other logic here
@@ -473,8 +462,6 @@ const resource = new SomeResource();
473462
```
474463

475464
```cjs
476-
const process = require('node:process');
477-
478465
function SomeResource() {
479466
// Initially set the loaded status to a rejected promise
480467
this.loaded = Promise.reject(new Error('Resource not yet loaded!'));
@@ -526,8 +513,6 @@ process.on('warning', (warning) => {
526513
```
527514

528515
```cjs
529-
const process = require('node:process');
530-
531516
process.on('warning', (warning) => {
532517
console.warn(warning.name); // Print the warning name
533518
console.warn(warning.message); // Print the warning message
@@ -663,8 +648,6 @@ process.on('SIGTERM', handle);
663648
```
664649

665650
```cjs
666-
const process = require('node:process');
667-
668651
// Begin reading from stdin so the process does not exit.
669652
process.stdin.resume();
670653

@@ -766,8 +749,6 @@ process.addUncaughtExceptionCaptureCallback((err) => {
766749
```
767750

768751
```cjs
769-
const process = require('node:process');
770-
771752
process.addUncaughtExceptionCaptureCallback((err) => {
772753
console.error('Caught exception:', err.message);
773754
return true; // Indicates exception was handled
@@ -1217,8 +1198,6 @@ process.debugPort = 5858;
12171198
```
12181199

12191200
```cjs
1220-
const process = require('node:process');
1221-
12221201
process.debugPort = 5858;
12231202
```
12241203

@@ -1355,8 +1334,6 @@ process.on('warning', (warning) => {
13551334
```
13561335
13571336
```cjs
1358-
const process = require('node:process');
1359-
13601337
process.on('warning', (warning) => {
13611338
console.warn(warning.name); // 'Warning'
13621339
console.warn(warning.message); // 'Something happened!'
@@ -1448,8 +1425,6 @@ process.on('warning', (warning) => {
14481425
```
14491426
14501427
```cjs
1451-
const process = require('node:process');
1452-
14531428
process.on('warning', (warning) => {
14541429
console.warn(warning.name);
14551430
console.warn(warning.message);
@@ -1865,8 +1840,6 @@ if (someConditionNotMet()) {
18651840
```
18661841
18671842
```cjs
1868-
const process = require('node:process');
1869-
18701843
// How to properly set the exit code while letting
18711844
// the process exit gracefully.
18721845
if (someConditionNotMet()) {
@@ -2408,8 +2381,6 @@ if (process.getegid) {
24082381
```
24092382
24102383
```cjs
2411-
const process = require('node:process');
2412-
24132384
if (process.getegid) {
24142385
console.log(`Current gid: ${process.getegid()}`);
24152386
}
@@ -2438,8 +2409,6 @@ if (process.geteuid) {
24382409
```
24392410
24402411
```cjs
2441-
const process = require('node:process');
2442-
24432412
if (process.geteuid) {
24442413
console.log(`Current uid: ${process.geteuid()}`);
24452414
}
@@ -2468,8 +2437,6 @@ if (process.getgid) {
24682437
```
24692438
24702439
```cjs
2471-
const process = require('node:process');
2472-
24732440
if (process.getgid) {
24742441
console.log(`Current gid: ${process.getgid()}`);
24752442
}
@@ -2499,8 +2466,6 @@ if (process.getgroups) {
24992466
```
25002467
25012468
```cjs
2502-
const process = require('node:process');
2503-
25042469
if (process.getgroups) {
25052470
console.log(process.getgroups()); // [ 16, 21, 297 ]
25062471
}
@@ -2529,8 +2494,6 @@ if (process.getuid) {
25292494
```
25302495
25312496
```cjs
2532-
const process = require('node:process');
2533-
25342497
if (process.getuid) {
25352498
console.log(`Current uid: ${process.getuid()}`);
25362499
}
@@ -2735,8 +2698,6 @@ kill(process.pid, 'SIGHUP');
27352698
```
27362699
27372700
```cjs
2738-
const process = require('node:process');
2739-
27402701
process.on('SIGHUP', () => {
27412702
console.log('Got SIGHUP signal.');
27422703
});
@@ -3852,8 +3813,6 @@ if (process.getegid && process.setegid) {
38523813
```
38533814
38543815
```cjs
3855-
const process = require('node:process');
3856-
38573816
if (process.getegid && process.setegid) {
38583817
console.log(`Current gid: ${process.getegid()}`);
38593818
try {
@@ -3897,8 +3856,6 @@ if (process.geteuid && process.seteuid) {
38973856
```
38983857
38993858
```cjs
3900-
const process = require('node:process');
3901-
39023859
if (process.geteuid && process.seteuid) {
39033860
console.log(`Current uid: ${process.geteuid()}`);
39043861
try {
@@ -3942,8 +3899,6 @@ if (process.getgid && process.setgid) {
39423899
```
39433900
39443901
```cjs
3945-
const process = require('node:process');
3946-
39473902
if (process.getgid && process.setgid) {
39483903
console.log(`Current gid: ${process.getgid()}`);
39493904
try {
@@ -3987,8 +3942,6 @@ if (process.getgroups && process.setgroups) {
39873942
```
39883943
39893944
```cjs
3990-
const process = require('node:process');
3991-
39923945
if (process.getgroups && process.setgroups) {
39933946
try {
39943947
process.setgroups([501]);
@@ -4031,8 +3984,6 @@ if (process.getuid && process.setuid) {
40313984
```
40323985
40333986
```cjs
4034-
const process = require('node:process');
4035-
40363987
if (process.getuid && process.setuid) {
40373988
console.log(`Current uid: ${process.getuid()}`);
40383989
try {

‎doc/api/sqlite.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ console.log(query.all());
5959
```
6060

6161
```cjs
62-
'use strict';
6362
const { DatabaseSync } = require('node:sqlite');
6463
const database = new DatabaseSync(':memory:');
6564

@@ -325,7 +324,6 @@ database.loadExtension('./base64.dylib', 'sqlite3_base64_init');
325324
```
326325

327326
```cjs
328-
'use strict';
329327
const { DatabaseSync } = require('node:sqlite');
330328
const database = new DatabaseSync(':memory:', { allowExtension: true });
331329

‎doc/api/test.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -851,7 +851,6 @@ test('spies on a function', () => {
851851
```
852852

853853
```cjs
854-
'use strict';
855854
const assert = require('node:assert');
856855
const { mock, test } = require('node:test');
857856

‎doc/api/tracing.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,6 @@ collect();
326326
```
327327

328328
```cjs
329-
'use strict';
330-
331329
const { Session } = require('node:inspector');
332330
const session = new Session();
333331
session.connect();

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL