Skip to content

Commit a97c80c

Browse files
Aviv Kellertargos
Aviv Keller
authored andcommitted
doc: add note about --expose-internals
PR-URL: #52861 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
1 parent d4873bc commit a97c80c

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

lib/internal/README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# Internal Modules
22

3-
The modules in `lib/internal` are intended for internal use in Node.js core
4-
only, and are not accessible with `require()` from user modules. These modules
5-
can be changed at **any** time. Reliance on these modules outside of core
6-
is **not supported** in any way.
3+
The modules located in `lib/internal` directory are exclusively meant
4+
for internal usage within the Node.js core. They are not intended to
5+
be accessed via user modules `require()`. These modules may change at
6+
any point in time. Relying on these internal modules outside the core
7+
is not supported and can lead to unpredictable behavior.
8+
9+
In certain scenarios, accessing these internal modules for debugging or
10+
experimental purposes might be necessary. Node.js provides the `--expose-internals`
11+
flag to expose these modules to userland code. This flag only exists to
12+
assist Node.js maintainers with debugging internals. It is not meant for
13+
use outside the project.

0 commit comments

Comments
 (0)