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 2 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
8 changes: 5 additions & 3 deletions doc/api/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1093,9 +1093,11 @@ 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 CommonJS or ESM script that is used as the
package entry point.
benmccann marked this conversation as resolved.
Show resolved Hide resolved

When the value is a directory, [it may only be loaded via
`require()`](modules.md#folders-as-modules).
benmccann marked this conversation as resolved.
Show resolved Hide resolved

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