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: clarify that import also uses main #41720

Merged
merged 5 commits into from
Jan 30, 2022
Merged

doc: clarify that import also uses main #41720

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71775aa
doc: clarify that import also uses main
benmccann Jan 27, 2022
c2d3f44
reword
benmccann Jan 28, 2022
fd21495
Update doc/api/packages.md
benmccann Jan 28, 2022
1f964a5
Update doc/api/packages.md
benmccann Jan 28, 2022
d4140a1
remove duplicate paragraph
benmccann Jan 28, 2022
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
14 changes: 8 additions & 6 deletions doc/api/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1093,17 +1093,19 @@ added: v0.4.0
}
```

The `"main"` field defines the script that is used when the [package directory
is loaded via `require()`](modules.md#folders-as-modules). Its value
is a path.
The `"main"` field defines the entry point of a package when imported by name
via a `node_modules` lookup. Its value is a path.

When a package has an [`"exports"`][] field, this will take precedence over the
`"main"` field when importing the package by name.

It also defines the script that is used when the [package directory is loaded
via `require()`](modules.md#folders-as-modules).

```cjs
require('./path/to/directory'); // This resolves to ./path/to/directory/main.js.
```

When a package has an [`"exports"`][] field, this will take precedence over the
`"main"` field when importing the package by name.

### `"packageManager"`

<!-- YAML
Expand Down