Skip to main content

在代码中使用 cron 作业

strapi.cron 对象允许你与 CRON 作业进行交互（有关更多详细信息，请参阅 配置参考）。

¥The strapi.cron object allows you to interact with CRON jobs (see configuration reference for more details).

添加或删除 cron 作业​

¥Add or remove cron jobs

cron 对象允许你将 cron 作业添加到 Strapi 实例。

¥The cron object allows you to add cron jobs to the Strapi instance.

./src/plugins/my-plugin/strapi-server.js
module.exports = () => ({
  bootstrap({ strapi }) {
    strapi.cron.add({
      // runs every second
      myJob: {
        task: ({ strapi }) => {
          console.log("hello from plugin");
        },
        options: {
          rule: "* * * * * *",
        },
      },
    });
  },
});

要删除 CRON 作业，你可以在 strapi.cron 对象上调用删除函数，并传入与要删除的 CRON 作业对应的键。

¥To remove a CRON job you can call the remove function on the strapi.cron object and pass in the key corresponding to the CRON job you want to remove.

✏️ 注意

无法删除使用 key 作为规则 的 Cron 作业。

¥Cron jobs that are using the key as the rule can not be removed.

strapi.cron.remove("myJob");

列出 cron 作业​

¥List cron jobs

要列出当前正在运行的所有 cron 作业，你可以在 strapi.cron 对象上调用 jobs 数组。

¥To list all the cron jobs that are currently running you can call the jobs array on the strapi.cron object.

strapi.cron.jobs