feat(types): remove this binding expectations on hook fn types
#736
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
This change improves the experience for TypeScript users that have the [`unbound-method`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/unbound-method.md) rule enabled. Without this change, check failures occur when users attempt to use destructured references to the functions returned in the `useAsyncStorage` hook's envelope object. Example: ```typescript const { getItem, setItem } = useAsyncStorage('someKey') // eslint@typescript-eslint/unbound-method // // Avoid referencing unbound methods which may cause unintentional // scoping of `this`. If your function does not access `this`, you can // annotate it with `this: void`, or consider using an arrow function // instead. ```
tido64
reviewed
Jan 14, 2022
This approach achieves the same end result as explicitly declaring the `this` type to be void and is more familiar to readers who know JS. Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
bilalq
changed the title
this binding expectations on hook fn types
|
Thanks for the fix ❤️ |
|
🎉 This PR is included in version 1.15.17 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
This change improves the experience for TypeScript users that have the
unbound-methodeslint rule enabled. Without this change, check failures occur when users attempt to use destructured references to the functions returned in theuseAsyncStoragehook's envelope object.Example:
Test Plan
This is a type change only, so no direct testing is applicable. However, the impacts of this typing change can be explored/tested in this TypeScript playground here.
This change uses a feature supported even in really old versions of TypeScript, so it should not be considered a breaking change. Even the oldest version available in the TypeScript playground supports this change just fine.