Skip to content

doc: clarify execution timing and common use cases of --require flag #62041

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

Open
kishanngowda wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: clarify execution timing and common use cases of --require flag #62041

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion doc/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2454,11 +2454,16 @@ changes:
description: This option also supports ECMAScript module.
-->

Preload the specified module at startup.
Preload the specified module at startup, before the main entry point
of the application is executed.
Comment on lines +2457 to +2458
Copy link
Contributor

@aduh95 aduh95 Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the other suggestion, we should remove it here to avoid duplication

Suggested change
Preload the specified module at startup, before the main entry point
of the application is executed.
Preload the specified module at startup.


Follows `require()`'s module resolution
rules. `module` may be either a path to a file, or a node module name.

This option is commonly used to initialize global configuration,
set up instrumentation, or apply polyfills before any application
code runs.

Modules preloaded with `--require` will run before modules preloaded with `--import`.
Copy link
Contributor

@aduh95 aduh95 Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's true that it's both before the entry point and before --import, but it might be worth giving the actual timeline

Suggested change
Modules preloaded with `--require` will run before modules preloaded with `--import`.
Modules preloaded with `--require` will run before modules preloaded with `--import`, which will run before the program entry point is executed.


Modules are preloaded into the main thread as well as any worker threads,
Expand Down