doc: require() tries first core not native modules #10324

vice · 2016-12-18T16:54:36Z

All core modules are native but not all native modules are in core.

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

Change a single word in documentation with a more precise one.

nouex · 2016-12-19T04:46:40Z

Could someone briefly clarify the difference between native and core?

gibfahn · 2016-12-19T11:03:13Z

@reecehudson As I understand it, core modules are ones built into Node itself, things in ./lib like http and fs. Native modules are modules that use C++ (not just Javascript) and must be compiled for a particular system.

vice · 2016-12-19T11:37:44Z

Native is a module compiled in machine "native" code.
A module normally written in a compiled language not in JavaScript.

Core modules form Node's "core" functionalities.
You don't need to install them. They are included in every Node installation and documented in https://nodejs.org/api/ .

I suppose all core are native but it could be possible to have a core module not native and written completely in JavaScript.

Fishrock123 · 2016-12-19T15:42:01Z

doc/api/modules.md

@@ -368,7 +368,7 @@ example, then `require('./some-library')` would attempt to load:

 <!--type=misc-->

-If the module identifier passed to `require()` is not a native module,
+If the module identifier passed to `require()` is not a core module,


Maybe better to specify it as built-in core module?

There are core modules which are not built-in?

The word "core" isn't defined, I would use the word "built-in", its more descriptive, and more accurate.

Btw:

All core modules are native but not all native modules are in core.

This is not true. There are native modules built-in to node, but there are also lots of javascript modules built-in to node, see https://github.com/nodejs/node/tree/master/lib, and user's of the Node.js API can't tell the difference between native and javascript built-in modules, to my knowledge.

"Core Modules" is defined earlier in the same document: https://nodejs.org/dist/latest-v7.x/docs/api/modules.html#modules_core_modules

Thanks @richardlau. I'm OK then with the text proposed, but suggest the word "core module" be linked to the definition.

sam-github · 2016-12-19T16:40:16Z

doc/api/modules.md

@@ -368,7 +368,7 @@ example, then `require('./some-library')` would attempt to load:

 <!--type=misc-->

-If the module identifier passed to `require()` is not a native module,
+If the module identifier passed to `require()` is not a core module,


The word "core" isn't defined, I would use the word "built-in", its more descriptive, and more accurate.

Btw:

All core modules are native but not all native modules are in core.

This is not true. There are native modules built-in to node, but there are also lots of javascript modules built-in to node, see https://github.com/nodejs/node/tree/master/lib, and user's of the Node.js API can't tell the difference between native and javascript built-in modules, to my knowledge.

Change a single word in documentation with a more precise one. Native is a module compiled in machine "native" code. A module normally written in a compiled language, not in JavaScript. Core modules form Node's built-in "core" functionalities. You don't need to install them. They are included in every Node installation and documented in https://nodejs.org/api/ .

vice · 2016-12-20T01:21:27Z

I just changed the commit following reviews and requested changes.
I rewrite git history in my branch replacing older commit with an improved one.
I don't known if there is a better way to comply.

Now I know that non native built-in core modules exist :-)

Change a single word in documentation with a more precise one. Native is a module compiled in machine "native" code. A module normally written in a compiled language, not in JavaScript. Core modules form Node's built-in "core" functionalities. You don't need to install them. They are included in every Node installation and documented in https://nodejs.org/api/ . PR-URL: #10324 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

jasnell · 2016-12-23T06:44:43Z

Landed in f4cda23
(edit by @addaleax: used full SHA since the short one was ambiguous o.o)

Change a single word in documentation with a more precise one. Native is a module compiled in machine "native" code. A module normally written in a compiled language, not in JavaScript. Core modules form Node's built-in "core" functionalities. You don't need to install them. They are included in every Node installation and documented in https://nodejs.org/api/ . PR-URL: #10324 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem. lts-watch-v6.x labels Dec 18, 2016

cjihrig approved these changes Dec 18, 2016

View reviewed changes

italoacasas approved these changes Dec 19, 2016

View reviewed changes

gibfahn approved these changes Dec 19, 2016

View reviewed changes

Fishrock123 reviewed Dec 19, 2016

View reviewed changes

sam-github suggested changes Dec 19, 2016

View reviewed changes

vice force-pushed the patch-1 branch from cbec4d9 to 53a91fa Compare December 20, 2016 01:09

nodejs-github-bot added lts-watch-v6.x labels Dec 20, 2016

sam-github approved these changes Dec 20, 2016

View reviewed changes

jasnell approved these changes Dec 23, 2016

View reviewed changes

jasnell closed this Dec 23, 2016

evanlucas mentioned this pull request Jan 3, 2017

v7.4.0 release proposal #10589

Merged

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels Jan 23, 2017

MylesBorins removed the lts-watch-v6.x label Jan 23, 2017

This was referenced Jan 24, 2017

v4.8.0 proposal #10973

Merged

v6.10.0 proposal #10974

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: require() tries first core not native modules #10324

doc: require() tries first core not native modules #10324

vice commented Dec 18, 2016

nouex commented Dec 19, 2016

gibfahn commented Dec 19, 2016

vice commented Dec 19, 2016 •

edited

Loading

Fishrock123 Dec 19, 2016

richardlau Dec 19, 2016

sam-github Dec 19, 2016

richardlau Dec 19, 2016

sam-github Dec 19, 2016

sam-github Dec 19, 2016

vice commented Dec 20, 2016

jasnell commented Dec 23, 2016 •

edited by addaleax

Loading

doc: require() tries first core not native modules #10324

doc: require() tries first core not native modules #10324

Conversation

vice commented Dec 18, 2016

Checklist

Affected core subsystem(s)

Description of change

nouex commented Dec 19, 2016

gibfahn commented Dec 19, 2016

vice commented Dec 19, 2016 • edited Loading

Fishrock123 Dec 19, 2016

Choose a reason for hiding this comment

richardlau Dec 19, 2016

Choose a reason for hiding this comment

sam-github Dec 19, 2016

Choose a reason for hiding this comment

richardlau Dec 19, 2016

Choose a reason for hiding this comment

sam-github Dec 19, 2016

Choose a reason for hiding this comment

sam-github Dec 19, 2016

Choose a reason for hiding this comment

vice commented Dec 20, 2016

jasnell commented Dec 23, 2016 • edited by addaleax Loading

vice commented Dec 19, 2016 •

edited

Loading

jasnell commented Dec 23, 2016 •

edited by addaleax

Loading