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.

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

doc: esm: improve dual package hazard docs #30345

Closed
wants to merge 9 commits into from
Closed

doc: esm: improve dual package hazard docs #30345

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c469d4b
doc: esm: improve dual package hazard docs
GeoffreyBooth Nov 9, 2019
6526130
doc: esm: remove example from hazard section
GeoffreyBooth Nov 11, 2019
1f7b577
doc: esm: revisions per feedback
GeoffreyBooth Nov 12, 2019
c9b6df3
doc: esm: give "main" a heading, mention other entry points
GeoffreyBooth Nov 13, 2019
2637f4d
doc: esm: add intro to package entry points section
GeoffreyBooth Nov 14, 2019
4b75b64
doc: rename for clarity
GeoffreyBooth Nov 14, 2019
a0d7c99
doc: merge intro language
GeoffreyBooth Nov 14, 2019
94e85ab
doc: typo
GeoffreyBooth Nov 16, 2019
912f281
doc: typo
GeoffreyBooth Nov 16, 2019
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
Prev Previous commit
Next Next commit
doc: esm: give "main" a heading, mention other entry points
  • Loading branch information
@GeoffreyBooth
GeoffreyBooth committed Nov 13, 2019
commit c9b6df34e59ef3ce402c83a6c6167d5d3d5982d1
10 changes: 9 additions & 1 deletion doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,8 @@ unspecified.

### Package Entry Points

#### <code>package.json</code> <code>"main"</code>

The `package.json` `"main"` field defines the entry point for a package,
whether the package is included into CommonJS via `require` or into an ES
module via `import`.
Expand Down Expand Up @@ -219,7 +221,12 @@ The `"main"` field can point to exactly one file, regardless of whether the
package is referenced via `require` (in a CommonJS context) or `import` (in an
ES module context).

### Package Exports
[Package Exports][] provide an alternative to `"main"` where the package main
entry point can be defined while also encapsulating the package, preventing any
other entry points besides those defined in `"exports"`. If package entry points
are defined in both `"main"` and `"exports"`, the latter takes precedence.

#### Package Exports

By default, all subpaths from a package can be imported (`import 'pkg/x.js'`).
Custom subpath aliasing and encapsulation can be provided through the
Expand Down Expand Up @@ -1385,6 +1392,7 @@ success!
[ECMAScript-modules implementation]: https://github.com/nodejs/modules/blob/master/doc/plan-for-new-modules-implementation.md
[ES Module Integration Proposal for Web Assembly]: https://github.com/webassembly/esm-integration
[Node.js EP for ES Modules]: https://github.com/nodejs/node-eps/blob/master/002-es-modules.md
[Package Exports]: #esm_package_exports
[Terminology]: #esm_terminology
[WHATWG JSON modules specification]: https://html.spec.whatwg.org/#creating-a-json-module-script
[`data:` URLs]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
Expand Down