Interface TimerHandle

timer / ticker 实例的操作接口

由 createTimer 和 createTicker 返回。每个实例管理自己前缀下的定时器，互不干扰。

interface TimerHandle {
    set(
        key: string,
        callback: () => void | Promise<void>,
        ms: number,
    ): () => void;
    clear(key: string): void;
    clearAll(): void;
}

Index

Methods

set clear clearAll

Methods

set

set(key: string, callback: () => void | Promise<void>, ms: number): () => void
注册（或覆盖）一个定时任务，返回清除函数。

同 key 重复调用会先清除上一个定时器再注册新的。
Parameters
- key: string
- callback: () => void | Promise<void>
- ms: number
Returns () => void
- Defined in src/timer.ts:18

clear

clear(key: string): void
清除指定 key 的定时器
Parameters
- key: string
Returns void
- Defined in src/timer.ts:25

clearAll

clearAll(): void
清除此实例前缀下的所有定时器

Returns void
- Defined in src/timer.ts:28