|
1 | | -These flags are for Node.js core development usage only. Do not use these flags |
2 | | -in your own applications. These flags are not subjected to semantic versioning |
3 | | -rules. The core developers may remove these flags in any version of Node.js. |
| 1 | +# Node.js Core Development Flags |
4 | 2 |
|
5 | | -# Internal documentation of Node.js |
| 3 | +These flags are specifically designed for use in Node.js core development and are not intended for general |
| 4 | +application usage. |
6 | 5 |
|
7 | | -## CLI |
| 6 | +> \[!NOTE] |
| 7 | +> These APIs are not bound by semantic versioning rules, and they can be altered or removed in any version of Node.js |
| 8 | +
|
| 9 | +## Command Line Interface (CLI) |
8 | 10 |
|
9 | 11 | ### Flags |
10 | 12 |
|
11 | 13 | #### `--debug-arraybuffer-allocations` |
12 | 14 |
|
| 15 | +Enables debugging of `ArrayBuffer` allocations. |
| 16 | + |
13 | 17 | #### `--expose-internals` |
14 | 18 |
|
15 | | -Allows to require the `internal/*` modules. |
| 19 | +Allows the usage of `internal/*` modules, granting access to internal Node.js functionality. |
16 | 20 |
|
17 | 21 | #### `--inspect-brk-node[=[host:]port]` |
18 | 22 |
|
19 | | -<!-- YAML |
20 | | -added: v7.6.0 |
21 | | ---> |
22 | | - |
23 | | -Activate inspector on `host:port` and break at start of the first internal |
24 | | -JavaScript script executed when the inspector is available. |
25 | | -Default `host:port` is `127.0.0.1:9229`. |
| 23 | +Pauses execution at the start of Node.js application code, waiting for a debugger to connect on the specified |
| 24 | +`host` and `port`. This is useful for debugging application startup issues. If `host` and `port` are not |
| 25 | +provided, it defaults to `127.0.0.1:9229`. |
26 | 26 |
|
27 | 27 | #### `--node-snapshot` |
28 | 28 |
|
| 29 | +Enables the use of Node.js snapshots, potentially improving startup performance. |
| 30 | + |
29 | 31 | #### `--test-udp-no-try-send` |
30 | 32 |
|
| 33 | +Used for testing UDP functionality without attempting to send data. |
| 34 | + |
31 | 35 | #### `--trace-promises` |
32 | 36 |
|
| 37 | +Enables tracing of promises for debugging and performance analysis. |
| 38 | + |
33 | 39 | #### `--verify-base-objects` |
| 40 | + |
| 41 | +Allows verification of base objects for debugging purposes. |