ScheduledEvent
Background
A ScheduledEvent is the event type for scheduled requests to a Worker. It is the Object passed through as the event when a Worker's scheduled addEventListener() is invoked by a Worker's Cron Trigger.
Context
addEventListener("scheduled", event => { event.waitUntil(handleScheduled(event))})Properties
event.typestring- The type of event. This will always return
"scheduled".
- The type of event. This will always return
event.scheduledTimenumber- The time the
ScheduledEventwas scheduled to be executed in milliseconds since January 1, 1970, UTC. It can be parsed asnew Date(event.scheduledTime)
- The time the
Methods
When a Workers script is invoked by a Cron Trigger, the Workers runtime starts a ScheduledEvent which will be handled by the event listener registered for the type "scheduled". The event handler can invoke the following methods of the event object to control what happens next:
event.waitUntil(promisePromise)void- Use this method to notify the runtime to wait for asynchronous tasks (e.g. logging, analytics to third-party services, streaming and caching). The first
event.waitUntilto fail will be observed and recorded as the status in the Cron Trigger Past Events table. Otherwise, it will be reported as a Success.
- Use this method to notify the runtime to wait for asynchronous tasks (e.g. logging, analytics to third-party services, streaming and caching). The first