fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
915 B
915 B
category
| category |
|---|
| Animation |
useTimeoutFn
Wrapper for setTimeout with controls.
Usage
import { useTimeoutFn } from '@vueuse/core';
const { isPending, start, stop } = useTimeoutFn(() => {
/* ... */
}, 3000);
Type Declarations
export interface UseTimeoutFnOptions {
/**
* Start the timer immediately
*
* @default true
*/
immediate?: boolean;
/**
* Execute the callback immediately after calling `start`
*
* @default false
*/
immediateCallback?: boolean;
}
export type UseTimeoutFnReturn<CallbackFn extends AnyFn> = Stoppable<Parameters<CallbackFn> | []>;
/**
* Wrapper for `setTimeout` with controls.
*
* @param cb
* @param interval
* @param options
*/
export declare function useTimeoutFn<CallbackFn extends AnyFn>(
cb: CallbackFn,
interval: MaybeRefOrGetter<number>,
options?: UseTimeoutFnOptions,
): UseTimeoutFnReturn<CallbackFn>;