Skip to content

Commit 88bdbf1

Browse files
Trottdanielleadams
Trott
authored and
danielleadams
committedOct 5, 2021
doc: format markdown files in test directory
Use `make format-md` to format markdown files in `test` directory. PR-URL: #40290 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
·
v16.20.2v16.11.0
1 parent 9af2592 commit 88bdbf1

File tree

3 files changed

+163
-160
lines changed

3 files changed

+163
-160
lines changed
 

‎test/README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,27 @@ For the tests to run on Windows, be sure to clone Node.js source code with the
1313

1414
## Test Directories
1515

16-
| Directory | Runs on CI | Purpose |
17-
| ---------------- | ---------- | --------------- |
18-
| `abort` | Yes | Tests that use `--abort-on-uncaught-exception` and other situations where we want to test something but avoid generating a core file. |
19-
| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. |
20-
| `async-hooks` | Yes | Tests for [async\_hooks](https://nodejs.org/api/async\_hooks.html) functionality. |
21-
| `benchmark` | Yes | Test minimal functionality of benchmarks. |
22-
| `cctest` | Yes | C++ tests that are run as part of the build process. |
23-
| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24-
| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25-
| `doctool` | Yes | Tests for the documentation generator. |
26-
| `es-module` | Yes | Test ESM module loading. |
27-
| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28-
| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29-
| `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. |
30-
| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
31-
| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) |
32-
| `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. |
33-
| `parallel` | Yes | Various tests that are able to be run in parallel. |
34-
| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
35-
| `pummel` | No | Various tests for various modules / system functionality operating under load. |
36-
| `sequential` | Yes | Various tests that must not run in parallel. |
37-
| `testpy` | | Test configuration utility used by various test suites. |
38-
| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in `lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. |
39-
| `v8-updates` | No | Tests for V8 performance integration. |
16+
| Directory | Runs on CI | Purpose |
17+
| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18+
| `abort` | Yes | Tests that use `--abort-on-uncaught-exception` and other situations where we want to test something but avoid generating a core file. |
19+
| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. |
20+
| `async-hooks` | Yes | Tests for [async\_hooks](https://nodejs.org/api/async\_hooks.html) functionality. |
21+
| `benchmark` | Yes | Test minimal functionality of benchmarks. |
22+
| `cctest` | Yes | C++ tests that are run as part of the build process. |
23+
| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24+
| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25+
| `doctool` | Yes | Tests for the documentation generator. |
26+
| `es-module` | Yes | Test ESM module loading. |
27+
| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28+
| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29+
| `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. |
30+
| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
31+
| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) |
32+
| `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. |
33+
| `parallel` | Yes | Various tests that are able to be run in parallel. |
34+
| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
35+
| `pummel` | No | Various tests for various modules / system functionality operating under load. |
36+
| `sequential` | Yes | Various tests that must not run in parallel. |
37+
| `testpy` | | Test configuration utility used by various test suites. |
38+
| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in `lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. |
39+
| `v8-updates` | No | Tests for V8 performance integration. |

‎test/async-hooks/coverage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Showing which kind of async resource is covered by which test:
44

55
| Resource Type | Test |
6-
|---------------------|-----------------------------------------|
6+
| ------------------- | --------------------------------------- |
77
| CONNECTION | test-connection.ssl.js |
88
| FSEVENTWRAP | test-fseventwrap.js |
99
| FSREQCALLBACK | test-fsreqcallback-{access,readFile}.js |

‎test/common/README.md

+138-135
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ The `benchmark` module is used by tests to run benchmarks.
3131

3232
### `runBenchmark(name, args, env)`
3333

34-
* `name` [\<string>][] Name of benchmark suite to be run.
35-
* `args` [\<Array>][] Array of environment variable key/value pairs (ex:
34+
* `name` [\<string>][<string>] Name of benchmark suite to be run.
35+
* `args` [\<Array>][<Array>] Array of environment variable key/value pairs (ex:
3636
`n=1`) to be applied via `--set`.
37-
* `env` [\<Object>][] Environment variables to be applied during the run.
37+
* `env` [\<Object>][<Object>] Environment variables to be applied during the
38+
run.
3839

3940
## Common Module API
4041

@@ -43,14 +44,14 @@ tasks.
4344

4445
### `allowGlobals(...allowlist)`
4546

46-
* `allowlist` [\<Array>][] Array of Globals
47-
* return [\<Array>][]
47+
* `allowlist` [\<Array>][<Array>] Array of Globals
48+
* return [\<Array>][<Array>]
4849

4950
Takes `allowlist` and concats that with predefined `knownGlobals`.
5051

5152
### `canCreateSymLink()`
5253

53-
* return [\<boolean>][]
54+
* return [\<boolean>][<boolean>]
5455

5556
Checks whether the current running process can create symlinks. On Windows, this
5657
returns `false` if the process running doesn't have privileges to create
@@ -64,17 +65,17 @@ Creates a 10 MB file of all null characters.
6465

6566
### `enoughTestMem`
6667

67-
* [\<boolean>][]
68+
* [\<boolean>][<boolean>]
6869

6970
Indicates if there is more than 1gb of total memory.
7071

7172
### `expectsError(validator[, exact])`
7273

73-
* `validator` [\<Object>][] | [\<RegExp>][] | [\<Function>][] |
74-
[\<Error>][] The validator behaves identical to
75-
`assert.throws(fn, validator)`.
76-
* `exact` [\<number>][] default = 1
77-
* return [\<Function>][] A callback function that expects an error.
74+
* `validator` [\<Object>][<Object>] | [\<RegExp>][<RegExp>] |
75+
[\<Function>][<Function>] | [\<Error>][<Error>] The validator behaves
76+
identical to `assert.throws(fn, validator)`.
77+
* `exact` [\<number>][<number>] default = 1
78+
* return [\<Function>][<Function>] A callback function that expects an error.
7879

7980
A function suitable as callback to validate callback based errors. The error is
8081
validated using `assert.throws(() => { throw error; }, validator)`. If the
@@ -83,9 +84,9 @@ test is complete, then the test will fail.
8384

8485
### `expectWarning(name[, expected[, code]])`
8586

86-
* `name` [\<string>][] | [\<Object>][]
87-
* `expected` [\<string>][] | [\<Array>][] | [\<Object>][]
88-
* `code` [\<string>][]
87+
* `name` [\<string>][<string>] | [\<Object>][<Object>]
88+
* `expected` [\<string>][<string>] | [\<Array>][<Array>] | [\<Object>][<Object>]
89+
* `code` [\<string>][<string>]
8990

9091
Tests whether `name`, `expected`, and `code` are part of a raised warning.
9192

@@ -130,23 +131,23 @@ expectWarning({
130131

131132
### `getArrayBufferViews(buf)`
132133

133-
* `buf` [\<Buffer>][]
134-
* return [\<ArrayBufferView>][]\[]
134+
* `buf` [\<Buffer>][<Buffer>]
135+
* return [\<ArrayBufferView>][<ArrayBufferView>]\[]
135136

136137
Returns an instance of all possible `ArrayBufferView`s of the provided Buffer.
137138

138139
### `getBufferSources(buf)`
139140

140-
* `buf` [\<Buffer>][]
141-
* return [\<BufferSource>][]\[]
141+
* `buf` [\<Buffer>][<Buffer>]
142+
* return [\<BufferSource>][<BufferSource>]\[]
142143

143144
Returns an instance of all possible `BufferSource`s of the provided Buffer,
144145
consisting of all `ArrayBufferView` and an `ArrayBuffer`.
145146

146147
### `getCallSite(func)`
147148

148-
* `func` [\<Function>][]
149-
* return [\<string>][]
149+
* `func` [\<Function>][<Function>]
150+
* return [\<string>][<string>]
150151

151152
Returns the file name and line number for the provided Function.
152153

@@ -158,13 +159,13 @@ The TTY file descriptor is assumed to be capable of being writable.
158159

159160
### `hasCrypto`
160161

161-
* [\<boolean>][]
162+
* [\<boolean>][<boolean>]
162163

163164
Indicates whether OpenSSL is available.
164165

165166
### `hasFipsCrypto`
166167

167-
* [\<boolean>][]
168+
* [\<boolean>][<boolean>]
168169

169170
Indicates that Node.js has been linked with a FIPS compatible OpenSSL library,
170171
and that FIPS as been enabled using `--enable-fips`.
@@ -175,104 +176,104 @@ used to determine that situation.
175176

176177
### `hasIntl`
177178

178-
* [\<boolean>][]
179+
* [\<boolean>][<boolean>]
179180

180181
Indicates if [internationalization][] is supported.
181182

182183
### `hasIPv6`
183184

184-
* [\<boolean>][]
185+
* [\<boolean>][<boolean>]
185186

186187
Indicates whether `IPv6` is supported on this platform.
187188

188189
### `hasMultiLocalhost`
189190

190-
* [\<boolean>][]
191+
* [\<boolean>][<boolean>]
191192

192193
Indicates if there are multiple localhosts available.
193194

194195
### `inFreeBSDJail`
195196

196-
* [\<boolean>][]
197+
* [\<boolean>][<boolean>]
197198

198199
Checks whether free BSD Jail is true or false.
199200

200201
### `isAIX`
201202

202-
* [\<boolean>][]
203+
* [\<boolean>][<boolean>]
203204

204205
Platform check for Advanced Interactive eXecutive (AIX).
205206

206207
### `isAlive(pid)`
207208

208-
* `pid` [\<number>][]
209-
* return [\<boolean>][]
209+
* `pid` [\<number>][<number>]
210+
* return [\<boolean>][<boolean>]
210211

211212
Attempts to 'kill' `pid`
212213

213214
### `isDumbTerminal`
214215

215-
* [\<boolean>][]
216+
* [\<boolean>][<boolean>]
216217

217218
### `isFreeBSD`
218219

219-
* [\<boolean>][]
220+
* [\<boolean>][<boolean>]
220221

221222
Platform check for Free BSD.
222223

223224
### `isIBMi`
224225

225-
* [\<boolean>][]
226+
* [\<boolean>][<boolean>]
226227

227228
Platform check for IBMi.
228229

229230
### `isLinux`
230231

231-
* [\<boolean>][]
232+
* [\<boolean>][<boolean>]
232233

233234
Platform check for Linux.
234235

235236
### `isLinuxPPCBE`
236237

237-
* [\<boolean>][]
238+
* [\<boolean>][<boolean>]
238239

239240
Platform check for Linux on PowerPC.
240241

241242
### `isOSX`
242243

243-
* [\<boolean>][]
244+
* [\<boolean>][<boolean>]
244245

245246
Platform check for macOS.
246247

247248
### `isSunOS`
248249

249-
* [\<boolean>][]
250+
* [\<boolean>][<boolean>]
250251

251252
Platform check for SunOS.
252253

253254
### `isWindows`
254255

255-
* [\<boolean>][]
256+
* [\<boolean>][<boolean>]
256257

257258
Platform check for Windows.
258259

259260
### `localhostIPv4`
260261

261-
* [\<string>][]
262+
* [\<string>][<string>]
262263

263264
IP of `localhost`.
264265

265266
### `localIPv6Hosts`
266267

267-
* [\<Array>][]
268+
* [\<Array>][<Array>]
268269

269270
Array of IPV6 representations for `localhost`.
270271

271272
### `mustCall([fn][, exact])`
272273

273-
* `fn` [\<Function>][] default = () => {}
274-
* `exact` [\<number>][] default = 1
275-
* return [\<Function>][]
274+
* `fn` [\<Function>][<Function>] default = () => {}
275+
* `exact` [\<number>][<number>] default = 1
276+
* return [\<Function>][<Function>]
276277

277278
Returns a function that calls `fn`. If the returned function has not been called
278279
exactly `exact` number of times when the test is complete, then the test will
@@ -282,9 +283,9 @@ If `fn` is not provided, an empty function will be used.
282283

283284
### `mustCallAtLeast([fn][, minimum])`
284285

285-
* `fn` [\<Function>][] default = () => {}
286-
* `minimum` [\<number>][] default = 1
287-
* return [\<Function>][]
286+
* `fn` [\<Function>][<Function>] default = () => {}
287+
* `minimum` [\<number>][<number>] default = 1
288+
* return [\<Function>][<Function>]
288289

289290
Returns a function that calls `fn`. If the returned function has not been called
290291
at least `minimum` number of times when the test is complete, then the test will
@@ -294,67 +295,67 @@ If `fn` is not provided, an empty function will be used.
294295

295296
### `mustNotCall([msg])`
296297

297-
* `msg` [\<string>][] default = 'function should not have been called'
298-
* return [\<Function>][]
298+
* `msg` [\<string>][<string>] default = 'function should not have been called'
299+
* return [\<Function>][<Function>]
299300

300301
Returns a function that triggers an `AssertionError` if it is invoked. `msg` is
301302
used as the error message for the `AssertionError`.
302303

303304
### `mustSucceed([fn])`
304305

305-
* `fn` [\<Function>][] default = () => {}
306-
* return [\<Function>][]
306+
* `fn` [\<Function>][<Function>] default = () => {}
307+
* return [\<Function>][<Function>]
307308

308309
Returns a function that accepts arguments `(err, ...args)`. If `err` is not
309310
`undefined` or `null`, it triggers an `AssertionError`. Otherwise, it calls
310311
`fn(...args)`.
311312

312313
### `nodeProcessAborted(exitCode, signal)`
313314

314-
* `exitCode` [\<number>][]
315-
* `signal` [\<string>][]
316-
* return [\<boolean>][]
315+
* `exitCode` [\<number>][<number>]
316+
* `signal` [\<string>][<string>]
317+
* return [\<boolean>][<boolean>]
317318

318319
Returns `true` if the exit code `exitCode` and/or signal name `signal` represent
319320
the exit code and/or signal name of a node process that aborted, `false`
320321
otherwise.
321322

322323
### `opensslCli`
323324

324-
* [\<boolean>][]
325+
* [\<boolean>][<boolean>]
325326

326327
Indicates whether 'opensslCli' is supported.
327328

328329
### `platformTimeout(ms)`
329330

330-
* `ms` [\<number>][] | [\<bigint>][]
331-
* return [\<number>][] | [\<bigint>][]
331+
* `ms` [\<number>][<number>] | [\<bigint>][<bigint>]
332+
* return [\<number>][<number>] | [\<bigint>][<bigint>]
332333

333334
Returns a timeout value based on detected conditions. For example, a debug build
334335
may need extra time so the returned value will be larger than on a release
335336
build.
336337

337338
### `PIPE`
338339

339-
* [\<string>][]
340+
* [\<string>][<string>]
340341

341342
Path to the test socket.
342343

343344
### `PORT`
344345

345-
* [\<number>][]
346+
* [\<number>][<number>]
346347

347348
A port number for tests to use if one is needed.
348349

349350
### `printSkipMessage(msg)`
350351

351-
* `msg` [\<string>][]
352+
* `msg` [\<string>][<string>]
352353

353354
Logs '1..0 # Skipped: ' + `msg`
354355

355356
### `pwdCommand`
356357

357-
* [\<array>][] First two argument for the `spawn`/`exec` functions.
358+
* [\<array>][<array>] First two argument for the `spawn`/`exec` functions.
358359

359360
Platform normalized `pwd` command options. Usage example:
360361

@@ -367,14 +368,14 @@ spawn(...common.pwdCommand, { stdio: ['pipe'] });
367368

368369
### `requireNoPackageJSONAbove([dir])`
369370

370-
* `dir` [\<string>][] default = \_\_dirname
371+
* `dir` [\<string>][<string>] default = \_\_dirname
371372

372373
Throws an `AssertionError` if a `package.json` file exists in any ancestor
373374
directory above `dir`. Such files may interfere with proper test functionality.
374375

375376
### `runWithInvalidFD(func)`
376377

377-
* `func` [\<Function>][]
378+
* `func` [\<Function>][<Function>]
378379

379380
Runs `func` with an invalid file descriptor that is an unsigned integer and
380381
can be used to trigger `EBADF` as the first argument. If no such file
@@ -383,7 +384,7 @@ will not be run.
383384

384385
### `skip(msg)`
385386

386-
* `msg` [\<string>][]
387+
* `msg` [\<string>][<string>]
387388

388389
Logs '1..0 # Skipped: ' + `msg` and exits with exit code `0`.
389390

@@ -476,15 +477,15 @@ Environment variables used in profiled processes.
476477
### `getCpuProfiles(dir)`
477478

478479
* `dir` {string} The directory containing the CPU profile files.
479-
* return [\<string>][]
480+
* return [\<string>][<string>]
480481

481482
Returns an array of all `.cpuprofile` files found in `dir`.
482483

483484
### `getFrames(file, suffix)`
484485

485486
* `file` {string} Path to a `.cpuprofile` file.
486487
* `suffix` {string} Suffix of the URL of call frames to retrieve.
487-
* returns { frames: [\<Object>][], nodes: [\<Object>][] }
488+
* returns { frames: [\<Object>][<Object>], nodes: [\<Object>][<Object>] }
488489

489490
Returns an object containing an array of the relevant call frames and an array
490491
of all the profile nodes.
@@ -508,10 +509,10 @@ Provides common functionality for tests for `node inspect`.
508509

509510
### `startCLI(args[[, flags], spawnOpts])`
510511

511-
* `args` [\<string>][]
512-
* `flags` [\<string>][] default = \[]
513-
* `showOpts` [\<Object>][] default = {}
514-
* return [\<Object>][]
512+
* `args` [\<string>][<string>]
513+
* `flags` [\<string>][<string>] default = \[]
514+
* `showOpts` [\<Object>][<Object>] default = {}
515+
* return [\<Object>][<Object>]
515516

516517
Returns a null-prototype object with properties that are functions and getters
517518
used to interact with the `node inspect` CLI. These functions are:
@@ -536,9 +537,9 @@ The `DNS` module provides utilities related to the `dns` built-in module.
536537

537538
### `errorLookupMock(code, syscall)`
538539

539-
* `code` [\<string>][] Defaults to `dns.mockedErrorCode`.
540-
* `syscall` [\<string>][] Defaults to `dns.mockedSysCall`.
541-
* return [\<Function>][]
540+
* `code` [\<string>][<string>] Defaults to `dns.mockedErrorCode`.
541+
* `syscall` [\<string>][<string>] Defaults to `dns.mockedSysCall`.
542+
* return [\<Function>][<Function>]
542543

543544
A mock for the `lookup` option of `net.connect()` that would result in an error
544545
with the `code` and the `syscall` specified. Returns a function that has the
@@ -554,39 +555,39 @@ The default `syscall` of errors generated by `errorLookupMock`.
554555

555556
### `readDomainFromPacket(buffer, offset)`
556557

557-
* `buffer` [\<Buffer>][]
558-
* `offset` [\<number>][]
559-
* return [\<Object>][]
558+
* `buffer` [\<Buffer>][<Buffer>]
559+
* `offset` [\<number>][<number>]
560+
* return [\<Object>][<Object>]
560561

561562
Reads the domain string from a packet and returns an object containing the
562563
number of bytes read and the domain.
563564

564565
### `parseDNSPacket(buffer)`
565566

566-
* `buffer` [\<Buffer>][]
567-
* return [\<Object>][]
567+
* `buffer` [\<Buffer>][<Buffer>]
568+
* return [\<Object>][<Object>]
568569

569570
Parses a DNS packet. Returns an object with the values of the various flags of
570571
the packet depending on the type of packet.
571572

572573
### `writeIPv6(ip)`
573574

574-
* `ip` [\<string>][]
575-
* return [\<Buffer>][]
575+
* `ip` [\<string>][<string>]
576+
* return [\<Buffer>][<Buffer>]
576577

577578
Reads an IPv6 String and returns a Buffer containing the parts.
578579

579580
### `writeDomainName(domain)`
580581

581-
* `domain` [\<string>][]
582-
* return [\<Buffer>][]
582+
* `domain` [\<string>][<string>]
583+
* return [\<Buffer>][<Buffer>]
583584

584585
Reads a Domain String and returns a Buffer containing the domain.
585586

586587
### `writeDNSPacket(parsed)`
587588

588-
* `parsed` [\<Object>][]
589-
* return [\<Buffer>][]
589+
* `parsed` [\<Object>][<Object>]
590+
* return [\<Buffer>][<Buffer>]
590591

591592
Takes in a parsed Object and writes its fields to a DNS packet as a Buffer
592593
object.
@@ -630,26 +631,26 @@ files in the `test/fixtures` directory.
630631

631632
### `fixtures.fixturesDir`
632633

633-
* [\<string>][]
634+
* [\<string>][<string>]
634635

635636
The absolute path to the `test/fixtures/` directory.
636637

637638
### `fixtures.path(...args)`
638639

639-
* `...args` [\<string>][]
640+
* `...args` [\<string>][<string>]
640641

641642
Returns the result of `path.join(fixtures.fixturesDir, ...args)`.
642643

643644
### `fixtures.readSync(args[, enc])`
644645

645-
* `args` [\<string>][] | [\<Array>][]
646+
* `args` [\<string>][<string>] | [\<Array>][<Array>]
646647

647648
Returns the result of
648649
`fs.readFileSync(path.join(fixtures.fixturesDir, ...args), 'enc')`.
649650

650651
### `fixtures.readKey(arg[, enc])`
651652

652-
* `arg` [\<string>][]
653+
* `arg` [\<string>][<string>]
653654

654655
Returns the result of
655656
`fs.readFileSync(path.join(fixtures.fixturesDir, 'keys', arg), 'enc')`.
@@ -668,12 +669,13 @@ one listed below. (`heap.validateSnapshotNodes(...)` is a shortcut for
668669

669670
### `heap.validateSnapshotNodes(name, expected, options)`
670671

671-
* `name` [\<string>][] Look for this string as the name of heap dump nodes.
672-
* `expected` [\<Array>][] A list of objects, possibly with an `children`
672+
* `name` [\<string>][<string>] Look for this string as the name of heap dump
673+
nodes.
674+
* `expected` [\<Array>][<Array>] A list of objects, possibly with an `children`
673675
property that points to expected other adjacent nodes.
674-
* `options` [\<Array>][]
675-
* `loose` [\<boolean>][] Do not expect an exact listing of occurrences
676-
of nodes with name `name` in `expected`.
676+
* `options` [\<Array>][<Array>]
677+
* `loose` [\<boolean>][<boolean>] Do not expect an exact listing of
678+
occurrences of nodes with name `name` in `expected`.
677679

678680
Create a heap dump and an embedder graph copy and validate occurrences.
679681

@@ -711,7 +713,7 @@ console.log('this is sent to the hijacked listener');
711713

712714
### `hijackStderr(listener)`
713715

714-
* `listener` [\<Function>][]: a listener with a single parameter
716+
* `listener` [\<Function>][<Function>]: a listener with a single parameter
715717
called `data`.
716718

717719
Eavesdrop to `process.stderr.write()` calls. Once `process.stderr.write()` is
@@ -721,7 +723,7 @@ the number of calls.
721723

722724
### `hijackStdout(listener)`
723725

724-
* `listener` [\<Function>][]: a listener with a single parameter
726+
* `listener` [\<Function>][<Function>]: a listener with a single parameter
725727
called `data`.
726728

727729
Eavesdrop to `process.stdout.write()` calls. Once `process.stdout.write()` is
@@ -865,27 +867,27 @@ internet-related tests.
865867

866868
### `internet.addresses`
867869

868-
* [\<Object>][]
869-
* `INET_HOST` [\<string>][] A generic host that has registered common
870+
* [\<Object>][<Object>]
871+
* `INET_HOST` [\<string>][<string>] A generic host that has registered common
870872
DNS records, supports both IPv4 and IPv6, and provides basic HTTP/HTTPS
871873
services
872-
* `INET4_HOST` [\<string>][] A host that provides IPv4 services
873-
* `INET6_HOST` [\<string>][] A host that provides IPv6 services
874-
* `INET4_IP` [\<string>][] An accessible IPv4 IP, defaults to the
874+
* `INET4_HOST` [\<string>][<string>] A host that provides IPv4 services
875+
* `INET6_HOST` [\<string>][<string>] A host that provides IPv6 services
876+
* `INET4_IP` [\<string>][<string>] An accessible IPv4 IP, defaults to the
875877
Google Public DNS IPv4 address
876-
* `INET6_IP` [\<string>][] An accessible IPv6 IP, defaults to the
878+
* `INET6_IP` [\<string>][<string>] An accessible IPv6 IP, defaults to the
877879
Google Public DNS IPv6 address
878-
* `INVALID_HOST` [\<string>][] An invalid host that cannot be resolved
879-
* `MX_HOST` [\<string>][] A host with MX records registered
880-
* `SRV_HOST` [\<string>][] A host with SRV records registered
881-
* `PTR_HOST` [\<string>][] A host with PTR records registered
882-
* `NAPTR_HOST` [\<string>][] A host with NAPTR records registered
883-
* `SOA_HOST` [\<string>][] A host with SOA records registered
884-
* `CNAME_HOST` [\<string>][] A host with CNAME records registered
885-
* `NS_HOST` [\<string>][] A host with NS records registered
886-
* `TXT_HOST` [\<string>][] A host with TXT records registered
887-
* `DNS4_SERVER` [\<string>][] An accessible IPv4 DNS server
888-
* `DNS6_SERVER` [\<string>][] An accessible IPv6 DNS server
880+
* `INVALID_HOST` [\<string>][<string>] An invalid host that cannot be resolved
881+
* `MX_HOST` [\<string>][<string>] A host with MX records registered
882+
* `SRV_HOST` [\<string>][<string>] A host with SRV records registered
883+
* `PTR_HOST` [\<string>][<string>] A host with PTR records registered
884+
* `NAPTR_HOST` [\<string>][<string>] A host with NAPTR records registered
885+
* `SOA_HOST` [\<string>][<string>] A host with SOA records registered
886+
* `CNAME_HOST` [\<string>][<string>] A host with CNAME records registered
887+
* `NS_HOST` [\<string>][<string>] A host with NS records registered
888+
* `TXT_HOST` [\<string>][<string>] A host with TXT records registered
889+
* `DNS4_SERVER` [\<string>][<string>] An accessible IPv4 DNS server
890+
* `DNS6_SERVER` [\<string>][<string>] An accessible IPv6 DNS server
889891

890892
A set of addresses for internet-related tests. All properties are configurable
891893
via `NODE_TEST_*` environment variables. For example, to configure
@@ -906,9 +908,9 @@ onGC({}, { ongc() { console.log('collected'); } });
906908

907909
### `onGC(target, listener)`
908910

909-
* `target` [\<Object>][]
910-
* `listener` [\<Object>][]
911-
* `ongc` [\<Function>][]
911+
* `target` [\<Object>][<Object>]
912+
* `listener` [\<Object>][<Object>]
913+
* `ongc` [\<Function>][<Function>]
912914

913915
Installs a GC listener for the collection of `target`.
914916

@@ -927,24 +929,25 @@ functionality.
927929

928930
### `findReports(pid, dir)`
929931

930-
* `pid` [\<number>][] Process ID to retrieve diagnostic report files for.
931-
* `dir` [\<string>][] Directory to search for diagnostic report files.
932-
* return [\<Array>][]
932+
* `pid` [\<number>][<number>] Process ID to retrieve diagnostic report files
933+
for.
934+
* `dir` [\<string>][<string>] Directory to search for diagnostic report files.
935+
* return [\<Array>][<Array>]
933936

934937
Returns an array of diagnostic report file names found in `dir`. The files
935938
should have been generated by a process whose PID matches `pid`.
936939

937940
### `validate(filepath)`
938941

939-
* `filepath` [\<string>][] Diagnostic report filepath to validate.
942+
* `filepath` [\<string>][<string>] Diagnostic report filepath to validate.
940943

941944
Validates the schema of a diagnostic report file whose path is specified in
942945
`filepath`. If the report fails validation, an exception is thrown.
943946

944947
### `validateContent(report)`
945948

946-
* `report` [\<Object>][] | [\<string>][] JSON contents of a diagnostic
947-
report file, the parsed Object thereof, or the result of
949+
* `report` [\<Object>][<Object>] | [\<string>][<string>] JSON contents of a
950+
diagnostic report file, the parsed Object thereof, or the result of
948951
`process.report.getReport()`.
949952

950953
Validates the schema of a diagnostic report whose content is specified in
@@ -957,16 +960,16 @@ after a given number of event loop "ticks".
957960

958961
### `tick(x, cb)`
959962

960-
* `x` [\<number>][] Number of event loop "ticks".
961-
* `cb` [\<Function>][] A callback function.
963+
* `x` [\<number>][<number>] Number of event loop "ticks".
964+
* `cb` [\<Function>][<Function>] A callback function.
962965

963966
## tmpdir Module
964967

965968
The `tmpdir` module supports the use of a temporary directory for testing.
966969

967970
### `path`
968971

969-
* [\<string>][]
972+
* [\<string>][<string>]
970973

971974
The realpath of the testing temporary directory.
972975

@@ -1015,18 +1018,18 @@ A driver class for running WPT with the WPT harness in a worker thread.
10151018

10161019
See [the WPT tests README][] for details.
10171020

1018-
[\<Array>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
1019-
[\<ArrayBufferView>]: https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView
1020-
[\<Buffer>]: https://nodejs.org/api/buffer.html#buffer_class_buffer
1021-
[\<BufferSource>]: https://developer.mozilla.org/en-US/docs/Web/API/BufferSource
1022-
[\<Error>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
1023-
[\<Function>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function
1024-
[\<Object>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
1025-
[\<RegExp>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
1026-
[\<bigint>]: https://github.com/tc39/proposal-bigint
1027-
[\<boolean>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type
1028-
[\<number>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type
1029-
[\<string>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type
1021+
[<Array>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
1022+
[<ArrayBufferView>]: https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView
1023+
[<Buffer>]: https://nodejs.org/api/buffer.html#buffer_class_buffer
1024+
[<BufferSource>]: https://developer.mozilla.org/en-US/docs/Web/API/BufferSource
1025+
[<Error>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
1026+
[<Function>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function
1027+
[<Object>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
1028+
[<RegExp>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
1029+
[<bigint>]: https://github.com/tc39/proposal-bigint
1030+
[<boolean>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type
1031+
[<number>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type
1032+
[<string>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type
10301033
[Web Platform Tests]: https://github.com/web-platform-tests/wpt
10311034
[`hijackstdio.hijackStdErr()`]: #hijackstderrlistener
10321035
[`hijackstdio.hijackStdOut()`]: #hijackstdoutlistener

0 commit comments

Comments
 (0)
Please sign in to comment.