useTimeout

类别

Animation

导出体积

402 B

上次更改

4 months ago

在一定时间后更新值，并带有控制功能。

示例

源码 playground (beta)

准备就绪：false

使用方法

import { promiseTimeout, useTimeout } from '@vueuse/core'

const ready = useTimeout(1000)

const { ready, start, stop } = useTimeout(1000, { controls: true })

console.log(ready.value) // false

await promiseTimeout(1200)

console.log(ready.value) // true

类型声明

typescript

export interface UseTimeoutOptions<Controls extends boolean>
  extends UseTimeoutFnOptions {
  /**
   * 暴露更多控制选项
   *
   * @default false
   */
  controls?: Controls
  /**
   * 超时时的回调函数
   */
  callback?: Fn
}
export type UseTimoutReturn =
  | ComputedRef<boolean>
  | ({
      readonly ready: ComputedRef<boolean>
    } & Stoppable)
/**
 * 在一定时间后更新值，并带有控制功能。
 *
 * @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