Skip to content

Commit e30c119

Browse files
Aviv Kellertpoisseau
Aviv Keller
authored andcommitted
doc: add missing definitions to internal-api.md
PR-URL: nodejs#53303 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
1 parent 3aa0b5a commit e30c119

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

doc/contributing/internal-api.md

+21-13
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,41 @@
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
42

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.
65

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)
810

911
### Flags
1012

1113
#### `--debug-arraybuffer-allocations`
1214

15+
Enables debugging of `ArrayBuffer` allocations.
16+
1317
#### `--expose-internals`
1418

15-
Allows to require the `internal/*` modules.
19+
Allows the usage of `internal/*` modules, granting access to internal Node.js functionality.
1620

1721
#### `--inspect-brk-node[=[host:]port]`
1822

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`.
2626

2727
#### `--node-snapshot`
2828

29+
Enables the use of Node.js snapshots, potentially improving startup performance.
30+
2931
#### `--test-udp-no-try-send`
3032

33+
Used for testing UDP functionality without attempting to send data.
34+
3135
#### `--trace-promises`
3236

37+
Enables tracing of promises for debugging and performance analysis.
38+
3339
#### `--verify-base-objects`
40+
41+
Allows verification of base objects for debugging purposes.

0 commit comments

Comments
 (0)