docs: Add links to Node.js API docs in various module replacements pages.#618
Merged
docs: Add links to Node.js API docs in various module replacements pages.#618
Conversation
…ges. And some minor, general improvements otherwise. Also note in the md5 page that is is insecure and has been for a long time.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the “module replacements” documentation by adding direct links to relevant Node.js (and some MDN) API docs, plus minor wording improvements to better guide readers toward native alternatives.
Changes:
- Add/standardize links to Node.js API documentation across multiple replacement pages.
- Add short explanatory text for certain replacements (e.g.,
through,split) to clarify intent/usage. - Add a stronger security note and reference link for MD5’s insecurity.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/modules/uuidv4.md | Clarifies crypto.randomUUID availability (browser + Node.js). |
| docs/modules/through.md | Adds a Node.js API doc link and a brief explanation for stream.Writable. |
| docs/modules/strip-ansi.md | Adds a Node.js API doc link and formats the API name as code. |
| docs/modules/split.md | Adds Node.js API doc link + explanatory text; updates example imports. |
| docs/modules/object-hash.md | Links SubtleCrypto.digest to MDN docs. |
| docs/modules/md5.md | Adds explicit insecurity warning + Wikipedia link; links Node crypto docs. |
| docs/modules/inherits.md | Adds MDN link for extends. |
| docs/modules/get-stream.md | Links Array.fromAsync to MDN and clarifies Node version note. |
| docs/modules/fs-extra.md | Links fs and fs/promises to Node.js API docs. |
| docs/modules/builtin-modules.md | Formats and links builtinModules to Node.js API docs. |
| docs/modules/buffer-equals.md | Links Buffer#equals to Node.js API docs and clarifies version text. |
| docs/modules/buffer-equal.md | Links Buffer#equals to Node.js API docs and clarifies version text. |
| docs/modules/buf-compare.md | Links Buffer.compare to Node.js API docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
43081j
reviewed
Apr 19, 2026
43081j
approved these changes
Apr 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Linked issue
N/A
📚 Description
This adds Node.js API docs links in various places where the native API is noted (and MDN in a few cases). Plus some minor, general improvements while I was going through the pages.
Also note in the md5 page that it is insecure and has been for a long time, with a link to the Wikipedia article.