useTimeoutFn

Category

Animation

Export Size

321 B

Last Changed

3 hours ago

Wrapper for setTimeout with controls.

Demo

source

Please wait for 3 seconds

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
}
/**
 * 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,
): Stoppable<Parameters<CallbackFn> | []>

Source

Source • Demo • Docs

Contributors

Anthony Fu

Anthony Fu

Scott Bedard

IlyaL

OrbisK

童欧巴

Dan Rose

Kasper Seweryn

jack zhang

vaakian X

Jelf

Shinigami

Peter Shih

liaoliao666

Sergey Shumov

Changelog

v12.6.0 on 2/14/2025

64c53 - feat(useTimtoutFn,useTimeoutPoll): align behavior (#4543)

v12.3.0 on 1/2/2025

59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)

v10.0.0-beta.4 on 4/13/2023

4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter

0a72b - feat(toValue): rename resolveUnref to toValue

v9.12.0 on 1/29/2023

39183 - feat(useRafFn, useIntervalFn, useTimeoutFn): make status readonly (#2685)

e054a - fix: respect callback parameters in start function (#2693)