docs: update externals function callback about boolean type
#12824
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
Deploying rspack with
|
| Latest commit: |
f66a7e5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b3e95980.rspack-v2.pages.dev |
| Branch Preview URL: | https://external-false.rspack-v2.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation for the externals function callback by adding comprehensive documentation for the boolean type support in the result parameter.
Changes:
- Added documentation for
booleantype in the callback'sresultparameter for both English and Chinese versions - Restructured the
resultparameter documentation with nested bullet points for improved readability - Clarified that
trueexternalizes using the original request path, whilefalseskips externalization and bundles the dependency
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/en/config/externals.mdx | Added boolean type documentation to externals function callback result parameter in English |
| website/docs/zh/config/externals.mdx | Added boolean type documentation to externals function callback result parameter in Chinese |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
boolean type
chenjiahan
approved these changes
Jan 23, 2026
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.
Summary
Update externals function callback documentation about
booleantype.Changes
true: Externalizes the dependency using the original request path as the external module namefalse: Tells Rspack to skip the remaining external configuration and bundle the dependency insteadresultparameter documentation with nested bullet points for better readability