Fix typings for Command element find all methods #170
Merged
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
…properly indicate whether the method returns a string or a string array.
jason0x43
requested changes
Mar 21, 2019
There was a problem hiding this comment.
This looks great. One more change would be great -- could we update getAttribute to use the same return type (attribute values are always strings or null), then remove any generics from the tests that involve getAttribute? That will clean up getAttribute and give us a test for the array value of StringResult.
…that a string or at string array is returned.
jason0x43
reviewed
Mar 22, 2019
src/Command.ts
Outdated
| @@ -1656,8 +1656,8 @@ export default class Command<T, P = any> | |||
| * @returns The value of the attribute, or `null` if no such attribute | |||
| * exists. | |||
| */ | |||
| getAttribute<T = any>(name: string) { | |||
| return this._callElementMethod<T>('getAttribute', name); | |||
| getAttribute(name: string) { | |||
There was a problem hiding this comment.
Can we leave the generic, but have it default to StringResult<T> instead of any? We don't actually need the generic, but removing out would cause problems for users that had been using it.
…ype as a generic to not break code that was previously using the method.
jason0x43
pushed a commit
that referenced
this pull request
Mar 29, 2019
* Use conditional types for the Command methods that run on Element to properly indicate whether the method returns a string or a string array. * Update the declaration of Command#getAttribute to correctly indicate that a string or at string array is returned. * Change the declaration of Command#getAttribute to support passing a type as a generic to not break code that was previously using the method.
jason0x43
added a commit
that referenced
this pull request
Apr 8, 2019
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.
Fixes #159.
I modified the type declarations on the
Commandmethods that operate onElementto correctly indicate when each method returns astringorstring[].