Update useThrottledCallback.ts

xnimorz · Nov 23, 2023 · 0dff362 · 0dff362
1 parent 71e1e81
commit 0dff362
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/useThrottledCallback.ts b/src/useThrottledCallback.ts
@@ -49,8 +49,8 @@ import useDebouncedCallback, {
  * window.addEventListener('scroll', scrollHandler)
  *
  * // Invoke `renewToken` when the click event is fired, but not more than once every 5 minutes.
- * const throttledRenewToken = useThrottledCallback(renewToken, 300000, { 'trailing': false })
- * <button onClick={throttledRenewToken}>click</button>
+ * const throttled = useThrottledCallback(renewToken, 300000, { 'trailing': false })
+ * <button onClick={throttled}>click</button>
  *
  * // Cancel the trailing throttled invocation.
  * window.addEventListener('popstate', throttled.cancel);