Skip to content

Commit 8aecbf4

Browse files
docs(hooks/useDoubleClick.ts): rename 'params' to 'props' in JSDoc (toss#214)
Co-authored-by: seungrodotlee <seungrodotlee@gmail.com>
1 parent 7087367 commit 8aecbf4

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/hooks/useDoubleClick/useDoubleClick.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ type UseDoubleClickProps<E extends HTMLElement> = {
1414
* It delays the single click callback execution for a specified time, and cancels it if a second click (i.e. a double click) occurs within that time.
1515
*
1616
* @template {HTMLElement} E - The specific type of HTMLElement to be used with this hook (e.g., HTMLButtonElement, HTMLDivElement).
17-
* @param {Object} params - Configuration options for click handling.
18-
* @param {number} [params.delay=250] - The number of milliseconds to wait before triggering the single click callback. Defaults to 250ms.
19-
* @param {(event: MouseEvent<E>) => void} [params.click] - The callback function to be executed on a single click.
20-
* @param {(event: MouseEvent<E>) => void} params.doubleClick - The callback function to be executed on a double click. Required.
17+
* @param {Object} props - Configuration options for click handling.
18+
* @param {number} [props.delay=250] - The number of milliseconds to wait before triggering the single click callback. Defaults to 250ms.
19+
* @param {(event: MouseEvent<E>) => void} [props.click] - The callback function to be executed on a single click.
20+
* @param {(event: MouseEvent<E>) => void} props.doubleClick - The callback function to be executed on a double click. Required.
2121
*
2222
* @returns {(event: MouseEvent<E>) => void} A click handler function to attach to an element's `onClick` event.
2323
*

0 commit comments

Comments
 (0)