Skip to content

Commit da2b335

Browse files
Suixinleievanlucas
authored andcommitted
doc: add builtin module in building.md
Fixes: #12516 Refs: #2497 PR-URL: #17705 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 35ef067 commit da2b335

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

BUILDING.md

+23
Original file line numberDiff line numberDiff line change
@@ -403,3 +403,26 @@ and [user guide](https://openssl.org/docs/fips/UserGuide-2.0.pdf).
403403
`/usr/local/ssl/fips-2.0`
404404
8. Build Node.js with `make -j`
405405
9. Verify with `node -p "process.versions.openssl"` (for example `1.0.2a-fips`)
406+
407+
## Building Node.js with external core modules
408+
409+
It is possible to specify one or more JavaScript text files to be bundled in
410+
the binary as builtin modules when building Node.js.
411+
412+
### Unix / macOS
413+
414+
This command will make `/root/myModule.js` available via
415+
`require('/root/myModule')` and `./myModule2.js` available via
416+
`require('myModule2')`.
417+
418+
```console
419+
$ ./configure --link-module '/root/myModule.js' --link-module './myModule2.js'
420+
```
421+
422+
### Windows
423+
424+
To make `./myCustomModule.js` available via `require('myCustomModule')`.
425+
426+
```console
427+
> .\vcbuild link-module './myCustomModule.js'
428+
```

0 commit comments

Comments
 (0)