scheduler namespace

函式

函式	說明
onSchedule(時間表, 處理常式)	排定函式的處理常式。相關聯的排程器工作傳送 http 要求時觸發。
onSchedule(選項, 處理常式)	排定函式的處理常式。相關聯的排程器工作傳送 http 要求時觸發。

介面

介面	說明
ScheduledEvent	這個介面代表傳遞至函式處理常式的 ScheduleEvent。
ScheduleFunction	排程觸發條件的 Cloud 函式類型，
ScheduleOptions	可對排程觸發條件設定的選項。

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

可匯出及部署的函式。