VueUseuseTimeout
Update value after a given time with controls.
Demo
Ready: false
Usage
js
import { promiseTimeout, useTimeout } from '@vueuse/core'
const ready = useTimeout(1000)
import { promiseTimeout, useTimeout } from '@vueuse/core'
const ready = useTimeout(1000)
js
const { ready, start, stop } = useTimeout(1000, { controls: true })
const { ready, start, stop } = useTimeout(1000, { controls: true })
js
console.log(ready.value) // false
await promiseTimeout(1200)
console.log(ready.value) // true
console.log(ready.value) // false
await promiseTimeout(1200)
console.log(ready.value) // true
Type Declarations
typescript
export interface UseTimeoutOptions<Controls extends boolean>
extends UseTimeoutFnOptions {
/**
* Expose more controls
*
* @default false
*/
controls?: Controls
/**
* Callback on timeout
*/
callback?: Fn
}
/**
* Update value after a given time with controls.
*
* @see {@link https://vueuse.org/useTimeout}
* @param interval
* @param options
*/
export declare function useTimeout(
interval?: number,
options?: UseTimeoutOptions<false>
): ComputedRef<boolean>
export declare function useTimeout(
interval: number,
options: UseTimeoutOptions<true>
): {
ready: ComputedRef<boolean>
} & Stoppable
export interface UseTimeoutOptions<Controls extends boolean>
extends UseTimeoutFnOptions {
/**
* Expose more controls
*
* @default false
*/
controls?: Controls
/**
* Callback on timeout
*/
callback?: Fn
}
/**
* Update value after a given time with controls.
*
* @see {@link https://vueuse.org/useTimeout}
* @param interval
* @param options
*/
export declare function useTimeout(
interval?: number,
options?: UseTimeoutOptions<false>
): ComputedRef<boolean>
export declare function useTimeout(
interval: number,
options: UseTimeoutOptions<true>
): {
ready: ComputedRef<boolean>
} & Stoppable
Source
Contributors
Anthony Fu
Waleed Khaled
vaakian X
Jelf
Shinigami
Mark Noonan