From 926467ab80ef0ea4b4f94f89883bb14fa314165d Mon Sep 17 00:00:00 2001 From: Suixinlei Date: Sat, 16 Dec 2017 13:19:16 +0800 Subject: [PATCH] doc: add builtin module in building.md Fixes: https://github.com/nodejs/node/issues/12516 Refs: https://github.com/nodejs/node/pull/2497 PR-URL: https://github.com/nodejs/node/pull/17705 Reviewed-By: Vse Mozhet Byt Reviewed-By: Joyee Cheung Reviewed-By: James M Snell --- BUILDING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 10e9a910be5397..74b5903ed22cd0 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -403,3 +403,26 @@ and [user guide](https://openssl.org/docs/fips/UserGuide-2.0.pdf). `/usr/local/ssl/fips-2.0` 8. Build Node.js with `make -j` 9. Verify with `node -p "process.versions.openssl"` (for example `1.0.2a-fips`) + +## Building Node.js with external core modules + +It is possible to specify one or more JavaScript text files to be bundled in +the binary as builtin modules when building Node.js. + +### Unix / macOS + +This command will make `/root/myModule.js` available via +`require('/root/myModule')` and `./myModule2.js` available via +`require('myModule2')`. + +```console +$ ./configure --link-module '/root/myModule.js' --link-module './myModule2.js' +``` + +### Windows + +To make `./myCustomModule.js` available via `require('myCustomModule')`. + +```console +> .\vcbuild link-module './myCustomModule.js' +```