Skip to content

Commit cdf4a9c

Browse files
maclover7MylesBorins
authored andcommitted
module: add builtinModules
Provides list of all builtin modules in Node. Includes modules of all types: - prefixed (ex: _tls_common) - deprecated (ex: sys) - regular (ex: vm) Backport-PR-URL: #18221 PR-URL: #16386 Refs: #3307 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 2268d00 commit cdf4a9c

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

doc/api/modules.md

+24
Original file line numberDiff line numberDiff line change
@@ -633,5 +633,29 @@ object. Since `require()` returns the `module.exports`, and the `module` is
633633
typically *only* available within a specific module's code, it must be
634634
explicitly exported in order to be used.
635635

636+
## The `Module` Object
637+
638+
<!-- YAML
639+
added: v0.3.7
640+
-->
641+
642+
* {Object}
643+
644+
Provides general utility methods when interacting with instances of
645+
`Module` -- the `module` variable often seen in file modules. Accessed
646+
via `require('module')`.
647+
648+
### module.builtinModules
649+
<!-- YAML
650+
added: REPLACEME
651+
-->
652+
653+
* {string[]}
654+
655+
A list of the names of all modules provided by Node.js. Can be used to verify
656+
if a module is maintained by a third-party module or not.
657+
658+
[`__dirname`]: #modules_dirname
659+
[`__filename`]: #modules_filename
636660
[`Error`]: errors.html#errors_class_error
637661
[module resolution]: #modules_all_together

lib/module.js

+7
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,16 @@ function Module(id, parent) {
4848
}
4949
module.exports = Module;
5050

51+
const builtinModules = Object.keys(NativeModule._source)
52+
.filter(NativeModule.nonInternalExists);
53+
54+
Object.freeze(builtinModules);
55+
Module.builtinModules = builtinModules;
56+
5157
Module._cache = {};
5258
Module._pathCache = {};
5359
Module._extensions = {};
60+
5461
var modulePaths = [];
5562
Module.globalPaths = [];
5663

test/parallel/test-module-builtin.js

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
'use strict';
2+
require('../common');
3+
const assert = require('assert');
4+
const { builtinModules } = require('module');
5+
6+
// Includes modules in lib/ (even deprecated ones)
7+
assert(builtinModules.includes('http'));
8+
assert(builtinModules.includes('sys'));
9+
10+
// Does not include internal modules
11+
assert.deepStrictEqual(
12+
builtinModules.filter((mod) => mod.startsWith('internal/')),
13+
[]
14+
);

0 commit comments

Comments
 (0)