Skip to content

doc: clarify conditional exports guidance #34306

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

Closed
wants to merge 3 commits into from
Closed

doc: clarify conditional exports guidance #34306

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
19db749
doc: clarify conditional exports guidance
guybedford Jul 11, 2020
d0f8926
Update doc/api/esm.md
guybedford Jul 11, 2020
d7f1f4e
rewording
guybedford Jul 13, 2020
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: 13 additions & 5 deletions doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,16 +456,24 @@ Conditional exports can also be extended to exports subpaths, for example:
"exports": {
".": "./main.js",
"./feature": {
"browser": "./feature-browser.js",
"node": "./feature-node.js",
"default": "./feature.js"
}
}
}
```

Defines a package where `require('pkg/feature')` and `import 'pkg/feature'`
could provide different implementations between the browser and Node.js,
given third-party tool support for a `"browser"` condition.
could provide different implementations between Node.js and other JS
environments.

When using environment branches, include
a `"defaut"` condition where possible. Always providing a `"default"` condition
ensures that any unknown JS environments are able to use a universal
implementation where possible, which helps avoid JS environments from having to
pretend to be existing environments to support packages with conditional
exports. Where possible, `"node"` and `"default"` conditions can be preferable
to `"browser"` conditions.

#### Nested conditions

Expand All @@ -479,11 +487,11 @@ use in Node.js but not the browser:
{
"main": "./main.js",
"exports": {
"browser": "./feature-browser.mjs",
"node": {
"import": "./feature-node.mjs",
"require": "./feature-node.cjs"
}
},
"default": "./feature.mjs",
}
}
```
Expand Down