Firebase is back at Google I/O on May 20-21! Register now.

scheduler namespace
Stay organized with collections Save and categorize content based on your preferences.

Functions

Function	Description
onSchedule(schedule, handler)	Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request.
onSchedule(options, handler)	Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request.

Interface	Description
ScheduledEvent	Interface representing a ScheduleEvent that is passed to the function handler.
ScheduleFunction	The Cloud Function type for Schedule triggers.
ScheduleOptions	Options that can be set on a Schedule trigger.

Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request.

Signature:

exportdeclarefunctiononSchedule(schedule:string,handler:(event:ScheduledEvent)=>void|Promise<void>):ScheduleFunction;

Parameter	Type	Description
schedule	string	The schedule, in Unix Crontab or AppEngine syntax.
handler	(event: ScheduledEvent) => void \| Promise<void>	A function to execute when triggered.

Returns:

ScheduleFunction

A function that you can export and deploy.

Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request.

Signature:

exportdeclarefunctiononSchedule(options:ScheduleOptions,handler:(event:ScheduledEvent)=>void|Promise<void>):ScheduleFunction;

Parameter	Type	Description
options	ScheduleOptions	Options to set on scheduled functions.
handler	(event: ScheduledEvent) => void \| Promise<void>	A function to execute when triggered.

Returns:

ScheduleFunction

A function that you can export and deploy.