refactor(jest-mock): simplify PropertyLikeKeys utility type
#13020
Conversation
This file contains 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
mrazauskas
commented
Jul 13, 2022
| @@ -374,8 +374,6 @@ expectType<SpyInstance<typeof indexSpiedObject.methodE>>( | |||
| spyOn(indexSpiedObject, 'methodE'), | |||
| ); | |||
|
|
|||
| expectError(spyOn(indexSpiedObject, 'propertyA')); | |||
There was a problem hiding this comment.
Same test is repeating few lines bellow.
| @@ -142,6 +142,6 @@ declare const objectProperties: PropertyLikeKeys<SomeObject>; | |||
| declare const indexObjectProperties: PropertyLikeKeys<IndexObject>; | |||
|
|
|||
| expectType<'propertyA' | 'propertyB' | 'propertyC'>(classProperties); | |||
| expectType<string>(indexClassProperties); | |||
| expectType<string | number>(indexClassProperties); | |||
There was a problem hiding this comment.
Fells like string | number is more correct or at least more TypeScriptish.
A note from TS docs: keyof {[k: string]: any} is of type string | number, "because JavaScript object keys are always coerced to a string".
There was a problem hiding this comment.
Just checked, TypeScript allows this:
type IndexObject = {
[key: string]: Record<string, any>;
};
const indexObject: IndexObject = {
123: {a: 123},
prop: {b: 'abc'},
};So it feels like this is correct (or?):
type IndexObject = {
[key: string]: Record<string, any>;
};
type PropKeys = PropertyLikeKeys<IndexObject>; // `string | number`
This was referenced Aug 3, 2022
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
The shape of
PropertyLikeKeysutility type looks somewhat redundant after #13013. I was not happy with it, hence decided to go for a refactor.Test plan
PropertyLikeKeysis covered by type test. These and all other type tests should pass.