Skip to content

doc: explain error message on missing main file #5812

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

Closed
drywolf wants to merge 1 commit into from
Closed

doc: explain error message on missing main file #5812

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
doc: explain error message on missing main file 
Added a hint saying that node uses the default "Cannot find module"
error when requiring a module for which the "main" file specified in
the package.json is missing.
  • Loading branch information
@drywolf
drywolf committed Mar 21, 2016
commit ba95e028f8a57e9213775e3a4dc68956496a2403
8 changes: 8 additions & 0 deletions doc/api/modules.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,14 @@ If this was in a folder at `./some-library`, then

This is the extent of Node.js's awareness of package.json files.

Note: If the file specified by the `"main"` entry of `package.json` is missing
and can not be resolved, Node.js will report the entire module as missing with
the default error:

```
Error: Cannot find module 'some-library'
```

If there is no package.json file present in the directory, then Node.js
will attempt to load an `index.js` or `index.node` file out of that
directory. For example, if there was no package.json file in the above
Expand Down