scheduler namespace

関数

関数 説明
onSchedule(schedule, handler) スケジュール設定された関数のハンドラ。関連するスケジューラ ジョブが HTTP リクエストを送信するたびにトリガーされます。
onSchedule(options, handler) スケジュール設定された関数のハンドラ。関連するスケジューラ ジョブが HTTP リクエストを送信するたびにトリガーされます。

インターフェース

インターフェース 説明
ScheduledEvent 関数ハンドラに渡される ScheduleEvent を表すインターフェース。
ScheduleFunction Schedule トリガーの Cloud Functions の関数タイプ。
ScheduleOptions Schedule トリガーで設定できるオプション。

scheduler.onSchedule()

スケジュール設定された関数のハンドラ。関連するスケジューラ ジョブが HTTP リクエストを送信するたびにトリガーされます。

署名:

export declare function onSchedule(schedule: string, handler: (event: ScheduledEvent) => void | Promise<void>): ScheduleFunction;

パラメータ

パラメータ 型 説明
スケジュール 文字列 Unix の Crontab または AppEngine 構文で記述したスケジュール。
handler （イベント: ScheduledEvent） =>void |約束 <void> トリガーされたときに実行する関数。

戻り値:

ScheduleFunction

エクスポートしてデプロイできる関数。

scheduler.onSchedule()

スケジュール設定された関数のハンドラ。関連するスケジューラ ジョブが HTTP リクエストを送信するたびにトリガーされます。

署名:

export declare function onSchedule(options: ScheduleOptions, handler: (event: ScheduledEvent) => void | Promise<void>): ScheduleFunction;

パラメータ

パラメータ 型 説明
オプション ScheduleOptions スケジュール設定された関数に設定するオプション。
handler （イベント: ScheduledEvent） =>void |約束 <void> トリガーされたときに実行する関数。

戻り値:

ScheduleFunction

エクスポートしてデプロイできる関数。