Skip to content

doc: add guidance on using node/default conditions for dual packages #62744

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
Jah-yee wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

doc: add guidance on using node/default conditions for dual packages #62744

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
18 changes: 18 additions & 0 deletions doc/api/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,24 @@ least specific in object order_.

Using the `"import"` and `"require"` conditions can lead to some hazards,
which are further explained in [the dual CommonJS/ES module packages section][].
As an alternative to using `"import"` and `"require"`, packages can use
`"node"` and `"default"` conditions to avoid the dual package hazard while
still providing ES modules for non-Node.js environments.

For example, using `"node"` and `"default"` instead of `"require"` and `"import"`:

```json
{
"exports": {
"node": "./index.cjs",
"default": "./index.mjs"
}
}
```

This approach avoids the dual package hazard in Node.js (since `"node"` always
matches for any Node.js environment) while still allowing bundlers to use the
ES module version when targeting other JavaScript runtimes.

The `"node-addons"` condition can be used to provide an entry point which
uses native C++ addons. However, this condition can be disabled via the
Expand Down
Loading