Skip to content

Commit b27eef3

Browse files
committed
doc: add signature for module.register
PR-URL: nodejs/node#49251 Backport-PR-URL: nodejs/node#50669 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Jacob Smith <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
1 parent 6b492da commit b27eef3

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

graal-nodejs/doc/api/esm.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1722,14 +1722,14 @@ success!
17221722
[`import`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import
17231723
[`initialize`]: #initialize
17241724
[`module.createRequire()`]: module.md#modulecreaterequirefilename
1725-
[`module.register()`]: module.md#moduleregister
1725+
[`module.register()`]: module.md#moduleregisterspecifier-parenturl-options
17261726
[`module.syncBuiltinESMExports()`]: module.md#modulesyncbuiltinesmexports
17271727
[`package.json`]: packages.md#nodejs-packagejson-field-definitions
17281728
[`port.postMessage`]: worker_threads.md#portpostmessagevalue-transferlist
17291729
[`port.ref()`]: https://nodejs.org/dist/latest-v17.x/docs/api/worker_threads.html#portref
17301730
[`port.unref()`]: https://nodejs.org/dist/latest-v17.x/docs/api/worker_threads.html#portunref
17311731
[`process.dlopen`]: process.md#processdlopenmodule-filename-flags
1732-
[`register`]: module.md#moduleregister
1732+
[`register`]: module.md#moduleregisterspecifier-parenturl-options
17331733
[`string`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
17341734
[`util.TextDecoder`]: util.md#class-utiltextdecoder
17351735
[cjs-module-lexer]: https://github.com./nodejs/cjs-module-lexer/tree/1.2.2

graal-nodejs/doc/api/module.md

+19-4
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,29 @@ isBuiltin('fs'); // true
7878
isBuiltin('wss'); // false
7979
```
8080
81-
### `module.register()`
81+
### `module.register(specifier[, parentURL][, options])`
8282
8383
<!-- YAML
8484
added: REPLACEME
8585
-->
8686
87-
In addition to using the `--experimental-loader` option in the CLI,
88-
loaders can be registered programmatically using the
89-
`module.register()` method.
87+
> Stability: 1.1 - Active development
88+
89+
* `specifier` {string} Customization hooks to be registered; this should be the
90+
same string that would be passed to `import()`, except that if it is relative,
91+
it is resolved relative to `parentURL`.
92+
* `parentURL` {string} If you want to resolve `specifier` relative to a base
93+
URL, such as `import.meta.url`, you can pass that URL here. **Default:**
94+
`'data:'`
95+
* `options` {Object}
96+
* `data` {any} Any arbitrary, cloneable JavaScript value to pass into the
97+
[`initialize`][] hook.
98+
* `transferList` {Object\[]} [transferrable objects][] to be passed into the
99+
`initialize` hook.
100+
* Returns: {any} returns whatever was returned by the `initialize` hook.
101+
102+
Register a module that exports hooks that customize Node.js module resolution
103+
and loading behavior.
90104
91105
```mjs
92106
import { register } from 'node:module';
@@ -384,3 +398,4 @@ returned object contains the following keys:
384398
[`module`]: modules.md#the-module-object
385399
[module wrapper]: modules.md#the-module-wrapper
386400
[source map include directives]: https://sourcemaps.info/spec.html#h.lmz475t4mvbx
401+
[transferrable objects]: worker_threads.md#portpostmessagevalue-transferlist

0 commit comments

Comments
 (0)