Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add missing definitions to internal-api.md #53303

Merged
merged 2 commits into from
Sep 18, 2024
Merged

doc: add missing definitions to internal-api.md #53303

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46be146
doc: add missing definitions to `internal-api.md`
RedYetiDev Jun 3, 2024
1dc3b7a
Update internal-api.md
RedYetiDev Sep 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 21 additions & 13 deletions doc/contributing/internal-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,41 @@
These flags are for Node.js core development usage only. Do not use these flags
in your own applications. These flags are not subjected to semantic versioning
rules. The core developers may remove these flags in any version of Node.js.
# Node.js Core Development Flags

# Internal documentation of Node.js
These flags are specifically designed for use in Node.js core development and are not intended for general
application usage.

## CLI
> \[!NOTE]
> These APIs are not bound by semantic versioning rules, and they can be altered or removed in any version of Node.js
## Command Line Interface (CLI)

### Flags

#### `--debug-arraybuffer-allocations`

Enables debugging of `ArrayBuffer` allocations.

#### `--expose-internals`

Allows to require the `internal/*` modules.
Allows the usage of `internal/*` modules, granting access to internal Node.js functionality.

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

<!-- YAML
added: v7.6.0
-->

Activate inspector on `host:port` and break at start of the first internal
JavaScript script executed when the inspector is available.
Default `host:port` is `127.0.0.1:9229`.
Pauses execution at the start of Node.js application code, waiting for a debugger to connect on the specified
`host` and `port`. This is useful for debugging application startup issues. If `host` and `port` are not
provided, it defaults to `127.0.0.1:9229`.

#### `--node-snapshot`

Enables the use of Node.js snapshots, potentially improving startup performance.

#### `--test-udp-no-try-send`

Used for testing UDP functionality without attempting to send data.

#### `--trace-promises`

Enables tracing of promises for debugging and performance analysis.

#### `--verify-base-objects`

Allows verification of base objects for debugging purposes.
Loading