> For the complete documentation index, see [llms.txt](https://yanzhandong868.gitbook.io/v3hooks/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yanzhandong868.gitbook.io/v3hooks/side/useinterval.md).

# useInterval

## 基础使用

```
<template>
  <div class="hello">
    <div>value:{{ data }}</div>
    <button @click="clear">关闭</button>
  </div>
</template>

<script lang="ts">
import { ref } from 'vue';
import { useInterval } from "../../../dist/index.js";


export default {

  setup() {
    const data = ref(1);
    let delay = ref<null | number>(1000);

    useInterval(()=>{
      data.value++
    },delay);

    const clear = ()=>{ 
      delay.value = null;
    };

    return {
      data,
      clear
    };
  },
};
</script>
```

每1000ms，执行一次，设置delay为null则立即中断

## 非中断式调用

```
<script lang="ts">
import { useInterval } from "v3hooks";
export default {

  setup() {
    useInterval(()=>{
      console.log('每 3s 执行一次')
    },3000)
  },
};
</script>
```

useInterval可以接受一个普通number参数,这样的useInterval可以接受一个普通number参数，不会被中断会一直被执行，谨慎使用！！

## Api

```
interface UseIntervalOptions {
    immediate?: boolean;
}
const useInterval: (
  fn: Fn, 
  delay: number | Ref<number | undefined | null>, 
  options?: UseIntervalOptions | undefined
) => void;
```

### Params

| 参数      | 说明                                 | 类型                                          | 默认值 |
| ------- | ---------------------------------- | ------------------------------------------- | --- |
| fn      | 要重复调用的函数                           | (...args: any\[]) => void                   | -   |
| delay   | 间隔时间，当取值为 null 或 undefined 时会停止计时器 | number \| Ref\<number \| undefined \| null> | -   |
| options | 配置计时器的行为，详见下面的 Options             | Options                                     | -   |

### Options

| 参数        | 说明                   | 类型      | 默认值   |
| --------- | -------------------- | ------- | ----- |
| immediate | 参数可以用来控制是否在首次渲染时立即执行 | boolean | false |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://yanzhandong868.gitbook.io/v3hooks/side/useinterval.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.