From b5a3c0499b713f9b650411ee7ae16e07f7ad4e17 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Wed, 20 Apr 2022 01:34:02 +0200 Subject: [PATCH] doc: clarify core modules that can be loaded without a prefix Refs: https://github.com/nodejs/node/pull/42325 PR-URL: https://github.com/nodejs/node/pull/42753 Reviewed-By: Geoffrey Booth Reviewed-By: Jacob Smith Reviewed-By: Mestery --- doc/api/modules.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/api/modules.md b/doc/api/modules.md index 6e8f703e5fd546..a633ac7c9ceb93 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -331,15 +331,17 @@ described in greater detail elsewhere in this documentation. The core modules are defined within the Node.js source and are located in the `lib/` folder. -Core modules are always preferentially loaded if their identifier is -passed to `require()`. For instance, `require('http')` will always -return the built in HTTP module, even if there is a file by that name. - -Core modules can also be identified using the `node:` prefix, in which case +Core modules can be identified using the `node:` prefix, in which case it bypasses the `require` cache. For instance, `require('node:http')` will always return the built in HTTP module, even if there is `require.cache` entry by that name. +Some core modules are always preferentially loaded if their identifier is +passed to `require()`. For instance, `require('http')` will always +return the built-in HTTP module, even if there is a file by that name. The list +of core modules that can be loaded without using the `node:` prefix is exposed +as [`module.builtinModules`][]. + ## Cycles @@ -1088,6 +1090,7 @@ This section was moved to [`__dirname`]: #__dirname [`__filename`]: #__filename [`import()`]: https://wiki.developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#Dynamic_Imports +[`module.builtinModules`]: module.md#modulebuiltinmodules [`module.children`]: #modulechildren [`module.id`]: #moduleid [`module` core module]: module.md