|
2 | 2 |
|
3 | 3 | ## Table of contents |
4 | 4 |
|
5 | | -* [Prerequisites](#prerequisites) |
6 | | - * [HTTP benchmark requirements](#http-benchmark-requirements) |
7 | | - * [HTTPS benchmark requirements](#https-benchmark-requirements) |
8 | | - * [HTTP/2 benchmark requirements](#http2-benchmark-requirements) |
9 | | - * [Benchmark analysis requirements](#benchmark-analysis-requirements) |
10 | | -* [Running benchmarks](#running-benchmarks) |
11 | | - * [Running individual benchmarks](#running-individual-benchmarks) |
12 | | - * [Calibrating the number of iterations with calibrate-n.js](#calibrating-the-number-of-iterations-with-calibrate-njs) |
13 | | - * [Running all benchmarks](#running-all-benchmarks) |
14 | | - * [Specifying CPU Cores for Benchmarks with run.js](#specifying-cpu-cores-for-benchmarks-with-runjs) |
15 | | - * [Filtering benchmarks](#filtering-benchmarks) |
16 | | - * [Comparing Node.js versions](#comparing-nodejs-versions) |
17 | | - * [Comparing parameters](#comparing-parameters) |
18 | | - * [Running benchmarks on the CI](#running-benchmarks-on-the-ci) |
19 | | -* [Creating a benchmark](#creating-a-benchmark) |
20 | | - * [Basics of a benchmark](#basics-of-a-benchmark) |
21 | | - * [Creating an HTTP benchmark](#creating-an-http-benchmark) |
| 5 | +* [How to write and run benchmarks in Node.js core](#how-to-write-and-run-benchmarks-in-nodejs-core) |
| 6 | + * [Table of contents](#table-of-contents) |
| 7 | + * [Prerequisites](#prerequisites) |
| 8 | + * [HTTP benchmark requirements](#http-benchmark-requirements) |
| 9 | + * [HTTPS benchmark requirements](#https-benchmark-requirements) |
| 10 | + * [HTTP/2 benchmark requirements](#http2-benchmark-requirements) |
| 11 | + * [Benchmark analysis requirements](#benchmark-analysis-requirements) |
| 12 | + * [Running benchmarks](#running-benchmarks) |
| 13 | + * [Setting CPU Frequency scaling governor to "performance"](#setting-cpu-frequency-scaling-governor-to-performance) |
| 14 | + * [Running individual benchmarks](#running-individual-benchmarks) |
| 15 | + * [Calibrating the number of iterations with calibrate-n.js](#calibrating-the-number-of-iterations-with-calibrate-njs) |
| 16 | + * [Running all benchmarks](#running-all-benchmarks) |
| 17 | + * [Specifying CPU Cores for Benchmarks with run.js](#specifying-cpu-cores-for-benchmarks-with-runjs) |
| 18 | + * [Filtering benchmarks](#filtering-benchmarks) |
| 19 | + * [Grouping benchmarks](#grouping-benchmarks) |
| 20 | + * [Comparing Node.js versions](#comparing-nodejs-versions) |
| 21 | + * [Comparing parameters](#comparing-parameters) |
| 22 | + * [Running benchmarks on the CI](#running-benchmarks-on-the-ci) |
| 23 | + * [Creating a benchmark](#creating-a-benchmark) |
| 24 | + * [Basics of a benchmark](#basics-of-a-benchmark) |
| 25 | + * [Creating an HTTP benchmark](#creating-an-http-benchmark) |
22 | 26 |
|
23 | 27 | ## Prerequisites |
24 | 28 |
|
@@ -562,7 +566,7 @@ The arguments of `createBenchmark` are: |
562 | 566 | * `configs` {Object} The benchmark parameters. `createBenchmark` will run all |
563 | 567 | possible combinations of these parameters, unless specified otherwise. |
564 | 568 | Each configuration is a property with an array of possible values. |
565 | | - The configuration values can only be strings or numbers. |
| 569 | + The configuration values can be strings, numbers, or booleans. |
566 | 570 | * `options` {Object} The benchmark options. Supported options: |
567 | 571 | * `flags` {Array} Contains node-specific command line flags to pass to |
568 | 572 | the child process. |
|
0 commit comments