tasks namespace

Functions

Function Description
taskQueue(options) Declares a function that can handle tasks enqueued using the Firebase Admin SDK.

Classes

Class Description
TaskQueueBuilder Builder for creating a TaskQueueFunction.

Interfaces

Interface Description
RateLimits How congestion control should be applied to the function.
RetryConfig How a task should be retried in the event of a non-2xx return.
TaskContext Metadata about a call to a Task Queue function.
TaskQueueFunction A handler for tasks.
TaskQueueOptions Options for configuring the task queue to listen to.

tasks.taskQueue()

Declares a function that can handle tasks enqueued using the Firebase Admin SDK.

Signature:

export declare function taskQueue(options?: TaskQueueOptions): TaskQueueBuilder;

Parameters

Parameter Type Description
options TaskQueueOptions Configuration for the Task Queue that feeds into this function. Omitting options will configure a Task Queue with default settings.

Returns:

TaskQueueBuilder