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

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

Functions

Function	Description
schedule(schedule)	Registers a Cloud Function to run at specified times.
topic(topic)	Registers a Cloud Function triggered when a Google Cloud Pub/Sub message is sent to a specified topic.

Class	Description
Message	Interface representing a Google Cloud Pub/Sub message.
ScheduleBuilder	The builder for scheduled functions, which are powered by Google Pub/Sub and Cloud Scheduler. Describes the Cloud Scheduler job that is deployed to trigger a scheduled function at the provided frequency. For more information, see [Schedule functions](/docs/functions/schedule-functions).Access via `functions.pubsub.schedule()`.
TopicBuilder	The Google Cloud Pub/Sub topic builder.Access via `functions.pubsub.topic()`.

Registers a Cloud Function to run at specified times.

Signature:

exportdeclarefunctionschedule(schedule:string):ScheduleBuilder;

Parameter	Type	Description
schedule	string	The schedule, in Unix Crontab or AppEngine syntax.

Returns:

ScheduleBuilder

ScheduleBuilder interface.

Registers a Cloud Function triggered when a Google Cloud Pub/Sub message is sent to a specified topic.

Signature:

exportdeclarefunctiontopic(topic:string):TopicBuilder;

Parameter	Type	Description
topic	string	The Pub/Sub topic to watch for message events.

Returns:

TopicBuilder

Pub/Sub topic builder interface.