docs(config): add TS callback literal widening note#21702
Open
Vishnuuuu24 wants to merge 1 commit intovitejs:mainfrom
Open
docs(config): add TS callback literal widening note#21702Vishnuuuu24 wants to merge 1 commit intovitejs:mainfrom
Vishnuuuu24 wants to merge 1 commit intovitejs:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation guidance for TypeScript users encountering literal widening issues in callback-based defineConfig. The change addresses issue #21684 where users experience TypeScript overload errors when setting options like minify: 'terser' in async config callbacks.
Changes:
- Added a note after the Async Config section explaining TypeScript literal widening in callback-based configs and providing two workarounds (
as constor explicit return type annotation)
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.
Summary
defineConfigliteral wideningas constor explicit callback return type) for overload errors in async/sync callback configWhy
Issue #21684 reports that in callback-based config, some nested string literals can be widened by TypeScript and trigger overload errors. This PR documents the existing TypeScript limitation and recommended workaround in the Async Config section.
Changes
docs/config/index.mdunder Async Config with a short note and guidanceValidation
pnpm run docs-buildRefs #21684