模块 timers

timers 模块是一个内置模块，提供了一些与时间相关的函数和对象，包括 setTimeout()、setInterval()、clearInterval()、clearTimeout() 等等

setInterval() 函数每隔指定的时间后调用函数，返回定时器对象。

1
2
3
4
5
6
var timers = require('timers');

function callback() {
    console.log('Hello, World!');
}
var intervalId = timers.setInterval(callback, 1000);

setTimeout() 函数在指定的时间后调用函数，返回定时器对象。

1
2
3
4
5
6
var timers = require('timers');

function callback() {
    console.log('Hello, World!');
}
var timeoutId = timers.setTimeout(callback, 1000);

clearTimeout() 函数用于取消一个由 setTimeout() 方法设置的定时器。需要提供的是在 setTimeout() 中返回的定时器标识符值。

1
2
3
4
5
6
7
var timers = require('timers');

function callback() {
    console.log('Hello, World!');
}
var timeoutId = timers.setTimeout(callback, 1000);
timers.clearTimeout(timeoutId);

clearInterval() 函数用于取消一个由 setInterval() 方法设置的定时器。需要提供的是在 setInterval() 中返回的定时器标识符值。

1
2
3
4
5
6
7
var timers = require('timers');

function callback() {
    console.log('Hello, World!');
}
var intervalId = timers.setInterval(callback, 1000);
timers.clearInterval(intervalId);

setImmediate() 函数用于在下一个闲置时间立即调用函数，返回定时器对象。

1
2
3
4
5
6
var timers = require('timers');

function callback() {
    console.log('Hello, World!');
}
var immediateId = timers.setImmediate(callback);

以上都是 timers 模块提供的常用函数和对象示例，通过使用这些函数和对象，可以方便的在应用程序中实现延迟执行任务或调度任务执行。

静态函数

setTimeout

在指定的时间后调用函数

1
2
3
static Timer timers.setTimeout(Function callback,
    Number timeout = 1,
    ...args);

调用参数:

• callback: Function, 指定回调函数
• timeout: Number, 指定延时的时间，以毫秒为单位。超过 2^31 的话,立即执行。
• args: ..., 额外的参数，传入到指定的 callback 内，可选。

返回结果:

• Timer, 返回定时器对象

---

clearTimeout

清除指定的定时器

1
static timers.clearTimeout(Value t);

调用参数:

• t: Value, 指定要清除的定时器

---

setInterval

每间隔指定的时间后调用函数

1
2
3
static Timer timers.setInterval(Function callback,
    Number timeout,
    ...args);

调用参数:

• callback: Function, 指定回调函数
• timeout: Number, 指定间隔的时间，以毫秒为单位。超过 2^31 的话,立即执行。
• args: ..., 额外的参数，传入到指定的 callback 内，可选。

返回结果:

• Timer, 返回定时器对象

---

clearInterval

清除指定的定时器

1
static timers.clearInterval(Value t);

调用参数:

• t: Value, 指定要清除的定时器

---

setHrInterval

每间隔指定的时间后调用函数，这是个高精度定时器，会主动打断正在运行的 JavaScript 脚本执行定时器

1
2
3
static Timer timers.setHrInterval(Function callback,
    Number timeout,
    ...args);

调用参数:

• callback: Function, 指定回调函数
• timeout: Number, 指定间隔的时间，以毫秒为单位。超过 2^31 的话,立即执行。
• args: ..., 额外的参数，传入到指定的 callback 内，可选。

返回结果:

• Timer, 返回定时器对象

由于 setHrInterval 的定时器会中断正在运行的代码执行回调，因此不要在回调函数内修改可能影响其它模块的数据，或者在回调中调用任何标记为 async 的 api 函数，否则将会产生不可预知的结果。例如：

1
2
3
4
5
6
7
8
9
10
var timers = require('timers');

var cnt = 0;
timers.setHrInterval(() => {
    cnt++;
}, 100);

while (cnt < 10);

console.error("===============================> done");

这段代码中，第 8 行的循环并不会因为 cnt 的改变而结束，因为 JavaScript 在优化代码时会认定在这个循环过程中 cnt 不会被改变。

---

clearHrInterval

清除指定的定时器

1
static timers.clearHrInterval(Value t);

调用参数:

• t: Value, 指定要清除的定时器

---

setImmediate

下一个空闲时间立即执行回调函数

1
2
static Timer timers.setImmediate(Function callback,
    ...args);

调用参数:

• callback: Function, 指定回调函数
• args: ..., 额外的参数，传入到指定的 callback 内，可选。

返回结果:

• Timer, 返回定时器对象

---

clearImmediate

清除指定的定时器

1
static timers.clearImmediate(Value t);

调用参数:

• t: Value, 指定要清除的定时器

---

call

调用给定的函数，并在超时时间到期时中断函数运行

1
2
3
static Value timers.call(Function func,
    Number timeout,
    ...args);

调用参数:

• func: Function, 指定要运行的函数
• timeout: Number, 指定超时时间
• args: ..., 额外的参数，传入到指定的 callback 内，可选。

返回结果:

• Value, 返回 func 的运行结果