diff --git a/zh-cn/application-dev/reference/apis/js-apis-timer.md b/zh-cn/application-dev/reference/apis/js-apis-timer.md index 1f11fe61e752a418a745e7950b0f450d55919d41..5b4fb66deff72bbcfc58dfc2c7348b12cc1aaa0e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-timer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-timer.md @@ -1,5 +1,10 @@ # 定时器 +定时器通过向任务队列添加任务,可在特定时间执行相应的函数。 + +> **说明:** +> +> 从API Version 7 开始,该接口不再维护,推荐使用新接口[@ohos.systemTimer](js-apis-system-timer.md)。 ## setTimeout @@ -7,19 +12,22 @@ setTimeout(handler[,delay[,…args]]): number 设置一个定时器,该定时器在定时器到期后执行一个函数。 -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | handler | Function | 是 | 定时器到期后执行函数。 | - | delay | number | 否 | 延迟的毫秒数,函数的调用会在该延迟之后发生。如果省略该参数,delay取默认值0,意味着“马上”执行,或尽快执行。 | - | ...args | Array<any> | 否 | 附加参数,一旦定时器到期,它们会作为参数传递给handler。 | +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| handler | Function | 是 | 定时器到期后执行函数。 | +| delay | number | 否 | 延迟的毫秒数,函数的调用会在该延迟之后发生。如果省略该参数,delay取默认值0,意味着“马上”执行,或尽快执行。 | +| ...args | Array<any> | 否 | 附加参数,一旦定时器到期,它们会作为参数传递给handler。 | + +**返回值:** -- 返回值 - | 类型 | 说明 | - | -------- | -------- | - | number | timeout定时器的ID。 | +| 类型 | 说明 | +| -------- | -------- | +| number | timeout定时器的ID。 | + +**示例:** -- 示例 ```js export default { setTimeOut() { @@ -37,12 +45,14 @@ clearTimeout(timeoutID: number): void 取消了先前通过调用setTimeout()建立的定时器。 -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | timeoutID | number | 是 | 要取消定时器的ID, 是由setTimeout()返回的。 | +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| timeoutID | number | 是 | 要取消定时器的ID, 是由setTimeout()返回的。 | + +**示例:** -- 示例 ```js export default { clearTimeOut() { @@ -61,19 +71,22 @@ setInterval(handler[, delay[, ...args]]): number 重复调用一个函数,在每次调用之间具有固定的时间延迟。 -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | handler | Function | 是 | 要重复调用的函数。 | - | delay | number | 否 | 延迟的毫秒数(一秒等于1000毫秒),函数的调用会在该延迟之后发生。 | - | ...args | Array<any> | 否 | 附加参数,一旦定时器到期,他们会作为参数传递给handler。 | +**参数:** -- 返回值 - | 类型 | 说明 | - | -------- | -------- | - | number | intervalID重复定时器的ID。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| handler | Function | 是 | 要重复调用的函数。 | +| delay | number | 否 | 延迟的毫秒数(一秒等于1000毫秒),函数的调用会在该延迟之后发生。 | +| ...args | Array<any> | 否 | 附加参数,一旦定时器到期,他们会作为参数传递给handler。 | + +**返回值:** + +| 类型 | 说明 | +| -------- | -------- | +| number | intervalID重复定时器的ID。 | + +**示例:** -- 示例 ```js export default { setInterval() { @@ -89,14 +102,16 @@ setInterval(handler[, delay[, ...args]]): number clearInterval(intervalID: number): void -可取消先前通过 setInterval() 设置的重复定时任务。 +可取消先前通过setInterval()设置的重复定时任务。 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| intervalID | number | 是 | 要取消的重复定时器的ID,是由 setInterval() 返回的。 | -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | intervalID | number | 是 | 要取消的重复定时器的ID,是由 setInterval() 返回的。 | +**示例:** -- 示例 ```js export default { clearInterval() {