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

Document MODULE_NOT_FOUND #21894

Closed
wants to merge 6 commits into from
Closed

Document MODULE_NOT_FOUND #21894

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
69bfb9f
Document MODULE_NOT_FOUND
jpage-godaddy Jul 19, 2018
29b6b62
Revert anchor
jpage-godaddy Jul 19, 2018
4d07005
Link to modules.require instead of global require
jpage-godaddy Jul 19, 2018
4c6925e
Remove another anchor (but why does everything else have one?)
jpage-godaddy Jul 19, 2018
53cb1c2
Sort mine (and others') references
jpage-godaddy Jul 19, 2018
ec9e432
Revert anchor revert
jpage-godaddy Jul 20, 2018
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
7 changes: 7 additions & 0 deletions doc/api/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1831,6 +1831,12 @@ unknown file extension.

Creation of a [`zlib`][] object failed due to incorrect configuration.

<a id="MODULE_NOT_FOUND"></a>
### MODULE_NOT_FOUND
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Should not this be ### ERR_MODULE_NOT_FOUND and be placed in a sorted way?
  2. It seems this doc does need <a id=... fragments.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the actual error name is currently just MODULE_NOT_FOUND.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this is the first error name out of the common name pattern?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is very unfortunate that this does not have the ERR_ prefix :-(

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code is 7 years old so we can't blame anyone for that : 3f987cd

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This definitely needs to include the <a id="#MODULE_NOT_FOUND"></a> anchor


A module file could not be resolved while attempting a [`require`][] or
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[`require`][] -> [`require()`][]

`import` operation.

[`'uncaughtException'`]: process.html#process_event_uncaughtexception
[`--force-fips`]: cli.html#cli_force_fips
[`child_process`]: child_process.html
Expand Down Expand Up @@ -1886,3 +1892,4 @@ Creation of a [`zlib`][] object failed due to incorrect configuration.
[try-catch]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
[vm]: vm.html
[WHATWG Supported Encodings]: util.html#util_whatwg_supported_encodings
[`require`]: modules.html#require
Copy link
Contributor

@mscdex mscdex Jul 19, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The right-hand side of this should be modules.html#modules_require instead.

1 change: 1 addition & 0 deletions doc/api/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,7 @@ A reference to the current module, see the section about the
[`module` object][]. In particular, `module.exports` is used for defining what
a module exports and makes available through `require()`.

<a id="require"></a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't necessary as the html generator for the markdown will create these id attributes automatically.

### require()
<!-- YAML
added: v0.1.13
Expand Down