docs: standardize API code examples to ESM - #65641
Closed
spjoshis wants to merge 1 commit into
Closed
Conversation
Collaborator
|
Review requested:
|
- Remove dual mjs/cjs code blocks from API documentation - Use single ```js blocks with ESM imports as the canonical form - Eliminates redundant documentation and reduces file size - Resolves nodejs#65536 Signed-off-by: Gopal <gopal.joshi73@hotmail.com>
Contributor
|
Please read the comment #65536 (comment) from @Renegade334
So it is too early to submit a PR to implement the proposed change. It first needs to be discussed. |
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
注册 for free
to join this conversation on GitHub.
Already have an account?
登录 to comment
3 participants
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.
Summary
mjs andcjs code blocks from API documentationWhy This Change Was Made
The dual ESM/CJS examples in the API docs were repetitive and difficult to maintain. Since converting between ESM and CJS imports for built-in modules is trivial and obvious, maintaining two separate blocks for each example was not a good use of documentation space or reviewer time.
This change follows the proposal in #65536 to canonicalize on ESM imports unless an example is specifically demonstrating CJS-specific behavior.
Test Plan
Fixes #65536