Clarify code documentation in useIntervalFn #3968
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
dosubot
bot
added
the
size:XS
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.
The documentation for the option
immediateCallbackinuseIntervalFnwas very misleading, making me search for a solution for a long time. Actually,immediateCallbackalready was the solution, but the documentation made me think otherwise:immediateCallbackdecides whether the callback is called immediately afterresumeis called. The former documentation said "Execute the callback immediate after calling this function", leaving it unclear what is meant by "this function" (I assumed it referred to the actual composable,useIntervalFn, but that's not the case).Thank you for this absolutely lifesaving library ❤️