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

Jump to bottom

doc: fix explanation of package.json "type" field #27516

Closed
wants to merge 3 commits into from
Closed

doc: fix explanation of package.json "type" field #27516

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fccd01b
doc: fix explanation of package.json "type" field
tamias May 1, 2019
1d63497
doc: further clarify package.json "type" field
tamias Dec 31, 2019
011fe06
doc: change "CommonJS modules" to "CommonJS"
tamias Jan 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/api/esm.md
View file
Open in desktop
Expand Up @@ -59,9 +59,9 @@ or when referenced by `import` statements within ES module code:

### `package.json` `"type"` field

Files ending with `.js` or `.mjs`, or lacking any extension,
will be loaded as ES modules when the nearest parent `package.json` file
contains a top-level field `"type"` with a value of `"module"`.
Files ending with `.js` or lacking any extension will be loaded as ES modules
BridgeAR marked this conversation as resolved.
Show resolved Hide resolved
when the nearest parent `package.json` file contains a top-level field `"type"`
with a value of `"module"`.

The nearest parent `package.json` is defined as the first `package.json` found
when searching in the current folder, that folder’s parent, and so on up
Expand Down Expand Up @@ -101,6 +101,9 @@ future-proof the package in case the default type of Node.js ever changes, and
it will also make things easier for build tools and loaders to determine how the
files in the package should be interpreted.

Regardless of the value of the `"type"` field, `.mjs` files are always treated
as ES modules and `.cjs` files are always treated as CommonJS.

### Package Scope and File Extensions

A folder containing a `package.json` file, and all subfolders below that
Expand Down