compose: Add types to withInstanceId and corresponding hook #31341
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
sarayourfriend
added
[Type] Code Quality
|
Size Change: +766 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
jsnajdr
reviewed
May 4, 2021
| */ | ||
| const withInstanceId: PropRemovingHigherOrderComponent< { | ||
| instanceId: string | number; | ||
| } > = createHigherOrderComponent( |
There was a problem hiding this comment.
Does it make sense to extract a InstanceIdProps or even export it? The type definition is used twice in the code.
There was a problem hiding this comment.
I originally did that but it made the extracted documentation worse because it made the type PropRemovingHigherOrderComponent< InstanceIdProps > instead of listing the props that are removed. Do you think it's still worth aliasing the type in that case?
There was a problem hiding this comment.
I would personally do it and document the InstanceIdProps type. But I don't mind either way.
To make documentation clearer, I would also rename the HOC type to PropInjectingHigherOrderComponent. Before it's too late after the NPM package is published and backward compatibility becomes an issue.
There was a problem hiding this comment.
FWIW we don't fully export the type from the package so there's no concern about change it immediately, but I do like that name better.
| * @param {Object} object Object reference to create an id for. | ||
| * @param {string} prefix Prefix for the unique id. | ||
| * @param {string} preferredId Default ID to use. | ||
| * @param {any} object Object reference to create an id for. |
There was a problem hiding this comment.
The type should be object instead of any (or unknown). The K type in WeakMap<K, V> is supposed to extend object. That prevents usages with primitive types that can't be WeakMap keys.
useInstanceId( 'hello' );will throw an exception at runtime (invalid value used as weak map key). And if the param's type is object, it will be a type error, too.
sarayourfriend
force-pushed
the
add/types-compose-with-instance-id
branch
from
5c7902a to
55a3ccc
Compare
jsnajdr
approved these changes
May 5, 2021
| */ | ||
| const withInstanceId: PropRemovingHigherOrderComponent< { | ||
| instanceId: string | number; | ||
| } > = createHigherOrderComponent( |
There was a problem hiding this comment.
I would personally do it and document the InstanceIdProps type. But I don't mind either way.
To make documentation clearer, I would also rename the HOC type to PropInjectingHigherOrderComponent. Before it's too late after the NPM package is published and backward compatibility becomes an issue.
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.
Description
Adds types to
withInstanceIdand fixes the types on the correspondinguseInstanceIdhook.useInstanceIdis changed to useanyinstead ofunknownas the underlyingWeakMapmust useany.How has this been tested?
No runtime changes, just type additions so as long unit tests and type checks pass we should be good
Part of #18838
Types of changes
New feature.
Checklist:
*.native.jsfiles for terms that need renaming or removal).