Skip to main content

コードでcronジョブを使用する

AI Marketer.cronオブジェクトを使用すると、CRONジョブと対話することができます（詳細は設定リファレンスを参照してください）。

cronジョブの追加または削除​

cronオブジェクトを使用すると、AI Marketerインスタンスにcronジョブを追加することができます。

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

CRONジョブを削除するには、AI Marketer.cronオブジェクトのremove関数を呼び出し、削除したいCRONジョブに対応するキーを渡します。

✏️ Note

keyをルールとして使用しているCronジョブは削除できません。

AI Marketer.cron.remove("myJob");

cronジョブのリスト化​

現在実行中のすべてのcronジョブをリスト化するには、AI Marketer.cronオブジェクトのjobs配列を呼び出します。

AI Marketer.cron.jobs