Skip to content

compose: Add types to useDebounce #32015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sarayourfriend merged 3 commits into from
May 21, 2021
Merged

compose: Add types to useDebounce #32015

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3be9815
compose: Add types to `useDebounce`
sarayourfriend May 19, 2021
21ebe47
Use more descriptive types
sarayourfriend May 20, 2021
7e1ee13
Improve documentation by adding descriptions
sarayourfriend May 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Improve documentation by adding descriptions
  • Loading branch information
@sarayourfriend
sarayourfriend committed May 20, 2021
commit 7e1ee137db3eabef0244f7a938566abbe16bf496
10 changes: 7 additions & 3 deletions packages/compose/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,11 +194,15 @@ be returned and any scheduled calls cancelled if any of the arguments change,
including the function to debounce, so please wrap functions created on
render in components in `useCallback`.

_Related_

- <https://docs-lodash.com/v4/debounce/>

_Parameters_

- _fn_ `TFunc`:
- _wait_ `[number]`:
- _options_ `[import('lodash').DebounceSettings]`:
- _fn_ `TFunc`: The function to debounce.
- _wait_ `[number]`: The number of milliseconds to delay.
- _options_ `[import('lodash').DebounceSettings]`: The options object.

_Returns_

Expand Down
8 changes: 5 additions & 3 deletions packages/compose/src/hooks/use-debounce/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ import { useEffect } from '@wordpress/element';
* including the function to debounce, so please wrap functions created on
* render in components in `useCallback`.
*
* @see https://docs-lodash.com/v4/debounce/
*
* @template {(...args: any[]) => void} TFunc
*
* @param {TFunc} fn
* @param {number} [wait]
* @param {import('lodash').DebounceSettings} [options]
* @param {TFunc} fn The function to debounce.
* @param {number} [wait] The number of milliseconds to delay.
* @param {import('lodash').DebounceSettings} [options] The options object.
* @return {TFunc & import('lodash').Cancelable} Debounced function.
*/
export default function useDebounce( fn, wait, options ) {
Expand Down