doc: guide for runtime-specific conditional exports using --import #59075
Conversation
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
|
Review requested:
|
nodejs-github-bot
added
doc
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.
Description
This PR adds an example to the
doc/api/esm.mddocumentation demonstrating how to simulate runtime-specific conditional exports (such as"electron") using the--importflag.Since Node.js does not currently support dynamically registering custom conditions for
"exports"resolution, this guide shows a practical workaround that leverages environment variables and preload scripts.The example illustrates:
This replaces the previous proposal to add a
registerCondition()API by showing a userland solution that does not require changes to Node.js core.✳️ Moved from the previous location (
doc/contributing/) to the API documentation underdoc/api/esm.mdas recommended in #59066