Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
martinstark authored Nov 19, 2024
1 parent 03b1db1 commit 0be3d6b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Yields the return value of the throttled function, or undefined when throttled/c

The throttled function keeps the type signature of the original function, plus `void`.

![image](https://github.com/user-attachments/assets/d806ab04-1a7b-42a7-907e-44168a3b0988)

Returns a `cancel` function which enables cleanup of the timeout, and blocks future calls to the throttled function. Useful when unmounting (react) ui components.

Returns a `reset` function which enables clearing the timeout, letting you call the method again before the delay has expired.
Expand Down

0 comments on commit 0be3d6b

Please sign in to comment.