Functions

timerWithControl()

timerWithControl(callback, options): object

创建可控的定时器

注意：不支持自动执行回调，需手动调用 start() 或 flush() 执行回调！

Parameters

Parameter	Type	Description
callback	Fn<[], void>	回调句柄
options	TimerWithControlOptions	配置项

Returns

object

flush()

flush: () => void

停止定时器并立即执行回调

Returns

void

isActive()

isActive: () => boolean

判断定时器是否处于激活状态

Returns

boolean

start()

start: () => void

启动定时器

Returns

void

stop()

stop: (cleanup) => void

停止定时器

Parameters

Parameter	Type	Default value
cleanup	boolean	false

Returns

void

Example

const timer = timerWithControl(() => {
  console.log(Date.now())
})

// 启动定时器
timer.start()

// 停止定时器
timer.stop()

// 停止定时器并立即执行回调
timer.flush()

Interfaces

TimerWithControlOptions

Properties

Property	Type	Description
immediateCallback?	boolean	启动定时器时立即执行一次回调 Default false
ms?	MaybeFn<number>	延迟时间，单位：ms，小于等于 0 时不会开启定时器，若 timerType='requestAnimation'，则此参数无效 Default 0
onCleanup?	() => void	手动执行 stop(cleanup = true) 时触发，用于清理 callback() 中的任务资源
type?	"setTimeout" | "setInterval" | "requestAnimationFrame"	定时器类型 - setTimeout: 仅执行一次回调 - setInterval: 循环执行回调，直到手动调用 stop() - requestAnimationFrame: 循环执行回调，直到手动调用 stop()，非客户端环境时降级为 setTimeout(fn, 16) Default 'setTimeout'