Skip to content

Commit

Permalink
doc: add builtin module in building.md
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Suixinlei authored and MylesBorins committed Feb 27, 2018
1 parent 5f1803b commit 896aa77
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,3 +409,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'
```

0 comments on commit 896aa77

Please sign in to comment.