fix: narrow DispatchOptions.upgrade type to string | null#5485
Open
mcollina wants to merge 1 commit into
Open
Conversation
The TypeScript type for DispatchOptions.upgrade included boolean, but the runtime validator in lib/core/request.js rejects any truthy non-string value. Narrowing the type to string | null aligns it with the runtime contract, preventing TypeScript-valid code from failing at runtime. Fixes #5466
ronag
approved these changes
Jul 2, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5485 +/- ##
==========================================
- Coverage 93.46% 93.45% -0.01%
==========================================
Files 110 110
Lines 37124 37147 +23
==========================================
+ Hits 34698 34716 +18
- Misses 2426 2431 +5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
metcoder95
approved these changes
Jul 2, 2026
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
Fixes #5466
DispatchOptions.upgradeacceptedbooleanin the TypeScript type, but the runtime validator inlib/core/request.jsrejects any truthy non-string value withInvalidArgumentError: upgrade must be a string. A TypeScript-valid call likeclient.dispatch({ path: '/', method: 'GET', upgrade: true }, handler)therefore fails at runtime.Changes
types/dispatcher.d.ts: Narrowedupgradefromboolean | string | nulltostring | nulltest/types/dispatcher.test-d.ts: Added type-level assertion thatupgrade: trueis rejected viaexpectNotAssignable, plus positive assertions forupgrade: 'websocket'andupgrade: nullTesting
expectNotAssignable<Dispatcher.DispatchOptions>({ ..., upgrade: true })— fails at type-check timeupgrade: 'websocket',upgrade: null) remains accepted