Skip to content

module: doc-deprecate module.register() #62395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GeoffreyBooth wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −2
Open

module: doc-deprecate module.register() #62395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4517,6 +4517,20 @@ Type: Documentation-only
Passing a non-extractable [`CryptoKey`][] to [`KeyObject.from()`][] is
deprecated and will throw an error in a future version.
### DEP0205: `module.register()`
<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/62395
description: Documentation-only deprecation.
-->
Type: Documentation-only
[`module.register()`][] is deprecated. Use [`module.registerHooks()`][]
instead.
[DEP0142]: #dep0142-repl_builtinlibs
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
Expand Down Expand Up @@ -4621,6 +4635,8 @@ deprecated and will throw an error in a future version.
[`message.trailersDistinct`]: http.md#messagetrailersdistinct
[`message.trailers`]: http.md#messagetrailers
[`module.createRequire()`]: module.md#modulecreaterequirefilename
[`module.register()`]: module.md#moduleregisterspecifier-parenturl-options
[`module.registerHooks()`]: module.md#moduleregisterhooksoptions
[`os.networkInterfaces()`]: os.md#osnetworkinterfaces
[`os.tmpdir()`]: os.md#ostmpdir
[`process.env`]: process.md#processenv
Expand Down
7 changes: 6 additions & 1 deletion doc/api/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,12 @@ isBuiltin('wss'); // false
added:
- v20.6.0
- v18.19.0
deprecated: REPLACEME
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/62395
description: Documentation-only deprecation (DEP0205). Use
`module.registerHooks()` instead.
- version:
- v23.6.1
- v22.13.1
Expand All @@ -193,7 +198,7 @@ changes:
description: Add support for WHATWG URL instances.
-->
> Stability: 1.1 - Active development
> Stability: 0 - Deprecated: Use [`module.registerHooks()`][] instead.
* `specifier` {string|URL} Customization hooks to be registered; this should be
the same string that would be passed to `import()`, except that if it is
Expand Down
2 changes: 1 addition & 1 deletion test/doctool/test-doc-api-json.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,5 +159,5 @@ for await (const dirent of await fs.opendir(new URL('../../out/doc/api/', import
assert.partialDeepStrictEqual(allExpectedKeys, findAllKeys(json));
}

assert.strictEqual(numberOfDeprecatedSections, 44); // Increase this number every time a new API is deprecated.
assert.strictEqual(numberOfDeprecatedSections, 45); // Increase this number every time a new API is deprecated.
assert.strictEqual(numberOfRemovedAPIs, 46); // Increase this number every time a section is marked as removed.
Loading