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.
1.4 KiB
1.4 KiB
category
| category |
|---|
| Animation |
useTimeout
Update value after a given time with controls.
Usage
import { useTimeout } from '@vueuse/core';
const ready = useTimeout(1000);
import { useTimeout } from '@vueuse/core';
// ---cut---
const { ready, start, stop } = useTimeout(1000, { controls: true });
import { promiseTimeout } from '@vueuse/core';
console.log(ready.value); // false
await promiseTimeout(1200);
console.log(ready.value); // true
Type Declarations
export interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutFnOptions {
/**
* Expose more controls
*
* @default false
*/
controls?: Controls;
/**
* Callback on timeout
*/
callback?: Fn;
}
export type UseTimeoutReturn =
| ComputedRef<boolean>
| ({
readonly ready: ComputedRef<boolean>;
} & Stoppable);
/**
* @deprecated use UseTimeoutReturn instead
*/
export type UseTimoutReturn = UseTimeoutReturn;
/**
* Update value after a given time with controls.
*
* @see {@link https://vueuse.org/useTimeout}
* @param interval
* @param options
*/
export declare function useTimeout(
interval?: MaybeRefOrGetter<number>,
options?: UseTimeoutOptions<false>,
): ComputedRef<boolean>;
export declare function useTimeout(
interval: MaybeRefOrGetter<number>,
options: UseTimeoutOptions<true>,
): {
ready: ComputedRef<boolean>;
} & Stoppable;