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.

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

doc: update to package.exports docs #33074

Closed
wants to merge 24 commits into from
Closed
Changes from 7 commits
Commits
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
8 changes: 8 additions & 0 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,14 @@ also be used within `"exports"` to define different package entry points per
environment, including whether the package is referenced via `require` or via
`import`.

**Warning**: Introducing the `"exports"` field prevents consumers of a package
from using any entry points that are not defined, including the `package.json`.
This will likely be a breaking change. To make the introduction of `"exports"`
non-breaking, ensure that every previously supported entry point is exported.
It is best to explicitly specify entry points so that the package's public API is
well-defined. As a last resort, package encapsulation can be disabled entirely by
MylesBorins marked this conversation as resolved.
Show resolved Hide resolved
creating an export for the root of the package `"./": "./"` that will expose every file.

If both `"exports"` and `"main"` are defined, the `"exports"` field takes
precedence over `"main"`.

Expand Down