npm 包 think-crontab 使用教程

npm 包 think-crontab 是一个基于 Node.js 的计划任务（定时任务）引擎，可用于执行定时任务或定时轮询任务。通过使用 think-crontab，可以轻松地按照特定的规则处理重复的任务。

安装 think-crontab

可以使用 npm 命令行工具进行本地或全局安装：

npm install think-crontab --save      // 本地安装
npm install think-crontab -g          // 全局安装

使用 think-crontab

初始化计划任务引擎

在执行计划任务之前，首先需要进行初始化：

const Crontab = require('think-crontab');

const crontab = new Crontab({
  log: true   // 是否启用日志
});

添加计划任务

crontab.add('*/5 * * * * *', () => {
  console.log('每隔 5 秒钟执行一次任务');
});

• 第一个参数是任务执行的时间规则，这里表示每隔 5 秒钟执行一次；
• 第二个参数是任务函数，可以是普通函数，Promise 函数等等。

移除计划任务

const taskId = crontab.add('*/5 * * * * *', () => {
  console.log('每隔 5 秒钟执行一次任务');
});

crontab.remove(taskId);

暂停计划任务

crontab.pauseTask(taskId);

恢复计划任务

crontab.resumeTask(taskId);

停止计划任务引擎

crontab.stop();

总结

think-crontab 是一个非常好用的计划任务引擎，可以帮助我们处理定时任务或定时轮询任务等多种场景。通过本文的介绍，相信大家已经能够熟练地使用该 npm 包了。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055ea381e8991b448dbfca