docs(useThrottle): clarify defaultValue initial value description #275
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.
Overview
This PR improves the documentation of the
useThrottle
hook by explicitly clarifying that theoptions.edges
property'sdefaultValue
represents the initial value.While the defaultValue attribute already indicates the initial value, for users new to react-simplikit and its docs, it may not be immediately obvious visually.
Therefore, this description adds a clear note that the initial value is
['leading', 'trailing']
to enhance usability and maintain consistency with other documentation styles in the codebase.This change follows the documentation style exemplified in the useLoading Docs.
Checklist
yarn run fix
to format and lint the code and docs?yarn run test:coverage
to make sure there is no uncovered line?