コールバックの予約

Scheduler プロバイダを使用すると、アプリケーションのルートを、指定した時間後に呼び出すか、間隔を空けて繰り返し呼び出すようにスケジュールできます。

メソッド署名

startAt(params: startAtParams)

種類

この関数は、スケジュールされたコールバックを設定するためのパラメータを受け取ります:

  • startAt: (String) - ISOフォーマットでスケジュールされたコールバックを開始する日付。
  • callback: (String) - 呼び出されるルート。
  • id: (オプションの文字列) - スケジュールされたコールバックの識別子。作成後にスケジューラをキャンセルする場合に使用します。
  • intervalオプション IntervalParams) - 指定された場合、スケジュールされたコールバックはこの間隔で繰り返されます。
  • payload: (オプションのオブジェクト) - コールバックに送信するオプションのデータ。

IntervalParams:

  • cronを使用する。 クロン 式を使って、ルートが呼び出される頻度をスケジュールする。
  • until: (UntilParams) - 指定時間後にスケジューラを停止する。

UntilParams:

  • dateISO 形式の日付。
  • maxInvocations: (Int) - スケジューラの最大実行回数。

コールバックのスケジュール

const session = vcr.createSession();
const scheduler = new Scheduler(session);

await scheduler.startAt({
    id: 'myScheduler',
    startAt: new Date(Date.now() + 5000).toISOString(),
    callback: 'onScheduler',
    payload: {
        text: 'hello world!',
    },
});