Skip to content

fix: add jsdoc comments to use-throttle #401

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

Open
ghostdevv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: add jsdoc comments to use-throttle #401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/sad-cars-open.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"runed": patch
---

fix: add jsdoc comments to use-throttle
57 changes: 57 additions & 0 deletions packages/runed/src/lib/utilities/use-throttle/use-throttle.svelte.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,71 @@
import { untrack } from "svelte";
import type { MaybeGetter } from "$lib/internal/types.js";

/**
* Represents the throttled wrapper returned by {@link useThrottle}.
*
* The wrapper is an async function that returns a {@link Promise} resolving to
* the original callback's return value. In addition to being callable, it
* provides two helper properties `cancel()` and `pending`.
*/
type UseThrottleReturn<Args extends unknown[], Return> = ((
this: unknown,
...args: Args
) => Promise<Return>) & {
/**
* Aborts any pending throttled execution and rejects the awaiting promise
* with the string `"Cancelled"`.
*/
cancel: () => void;

/**
* Whether a throttled call is currently waiting to be executed.
*/
pending: boolean;
};

/**
* Creates a throttled wrapper around a callback function.
*
* The returned function ensures that the original callback is invoked at most
* once per specified interval. Calls made during the wait period are queued
* and resolved with the result of the most recent invocation.
*
* @see https://runed.dev/docs/utilities/use-throttle
*
* @param callback - The function to be throttled.
* @param interval - The time interval in milliseconds, or a {@link MaybeGetter}
* returning the interval. If omitted, the default is `250`.
*
* @returns A throttled version of the callback: {@link UseThrottleReturn}.
*
* @example
* ```svelte
* <script lang="ts">
* import { useThrottle } from 'runed';
*
* let search = $state('');
* let throttledSearch = $state('');
*
* // Create a throttled fn – it runs at most once per 250ms
* const throttledUpdate = useThrottle(() => {
* throttledSearch = search;
* });
* </script>
*
* <input
* bind:value={{
* () => search,
* (v) => {
* search = v;
* throttledUpdate();
* }
* }}
* />
*
* <p>You searched for: <b>{throttledSearch}</b></p>
* ```
*/
export function useThrottle<Args extends unknown[], Return>(
callback: (...args: Args) => Return,
interval: MaybeGetter<number> = 250
Expand Down