docs: recommend node/default conditions to avoid dual package hazard#63582
Open
ShahabAhmed01 wants to merge 1 commit into
Open
docs: recommend node/default conditions to avoid dual package hazard#63582ShahabAhmed01 wants to merge 1 commit into
ShahabAhmed01 wants to merge 1 commit into
Conversation
Collaborator
|
Review requested:
|
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.
Fixes #52174
Problem
The current documentation suggests using
require/importconditions for dual CommonJS/ESM packages, which can lead to the dual package hazard where Node.js might load both versions of the package.Solution
Add documentation recommending
node/defaultconditions instead:node: loads the CJS version in Node.jsdefault: loads the ESM version for other platforms (browsers, bundlers)This approach avoids the dual package hazard while still providing ESM for browsers.
Changes
node/defaultconditions with exampleTesting
Documentation-only change, no code changes required.