useTimeout

useTimeout 在指定的时间后执行一个函数

基础用法

<template>
  <div>Hello World! {{ count }}</div>
</template>

<script setup lang="ts">
import { ref } from "vue";
import { useTimeout } from "hooks-vue3";
const count = ref<number>(0);
useTimeout(() => {
  count.value++;
}, 3000);
</script>

API

useTimeout(() => void, time:number);

参数TS类型

export type UseTimeoutFnReturn = {
  isRunning: Ref<boolean>; //是否已经触发了
  stop: () => void; //取消定时器
  start: () => void; //重新执行定时器
};
export type UseTimeoutFnOptions = {
  immediate?: boolean;
  autoStart?: boolean;
};

function useTimeout(
  callback: () => void,
  delay = 0,
  options?: UseTimeoutFnOptions,
): UseTimeoutFnReturn