fix(common): preserve literal key union in KeyValuePipe.transform() - #70200
Open
arturovt wants to merge 1 commit into
Open
fix(common): preserve literal key union in KeyValuePipe.transform()#70200arturovt wants to merge 1 commit into
arturovt wants to merge 1 commit into
Conversation
Previously, when you passed an object typed like
Record<'a' | 'b', number> into the `keyvalue` pipe, TypeScript would
"forget" that the keys could only ever be 'a' or 'b', and just tell
you the key was a plain `string` instead. So code like this used to
fail to compile, even though it's correct:
```ts
const input: Record<'a' | 'b', number> = {a: 1, b: 2};
const result = pipe.transform(input);
const key: 'a' | 'b' = result[0].key; // error: string is not 'a' | 'b'
```
This happened because the pipe has multiple overloaded versions of
transform(), and TypeScript checks them top to bottom, using the
first one that matches. The "number keys" overload was listed first,
and it happened to also match string-keyed objects by accident, so
it "won" before the correct "string keys" overload ever got a
chance to run.
The fix just reorders those two overloads so the string-keys one is
checked first. Nothing about runtime behavior changes — objects with
actual numeric keys (e.g. Record<1 | 2, string>) still correctly
report their keys as plain `string`, matching what Object.keys()
really returns at runtime.
Member
|
I'll run a TGP to see how breaking that is. |
JeanMeche
approved these changes
Aug 14, 2026
Member
|
We have a passing TGP. Can you please update the goldens. |
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.
Previously, when you passed an object typed like
Record<'a' | 'b', number> into the
keyvaluepipe, TypeScript would "forget" that the keys could only ever be 'a' or 'b', and just tell you the key was a plainstringinstead. So code like this used to fail to compile, even though it's correct:This happened because the pipe has multiple overloaded versions of transform(), and TypeScript checks them top to bottom, using the first one that matches. The "number keys" overload was listed first, and it happened to also match string-keyed objects by accident, so it "won" before the correct "string keys" overload ever got a chance to run.
The fix just reorders those two overloads so the string-keys one is checked first. Nothing about runtime behavior changes — objects with actual numeric keys (e.g. Record<1 | 2, string>) still correctly report their keys as plain
string, matching what Object.keys() really returns at runtime.