firebase-admin.functions package

Firebase Functions 服务。

函数

函数	说明
getFunctions(应用)	获取默认应用或指定应用的 Functions 服务。可以在不使用任何参数的情况下调用 getFunctions()，以访问默认应用的 Functions 服务；也可以作为 getFunctions(app) 调用与特定应用关联的 Functions 服务。

类

类	说明
函数	Firebase Functions 服务接口。
TaskQueue	TaskQueue 接口。

接口

接口	说明
AbsoluteDelivery	显示采用绝对交付任务选项的接口。
DelayDelivery	显示延迟递送的任务选项的界面。
TaskOptionsExperimental	表示实验性（Beta 版）任务选项的类型。

类型别名

类型别名	说明
DeliverySchedule	表示投放时间安排选项的类型。DeliverySchedule 是 DelayDelivery 和 AbsoluteDelivery 类型的联合类型。
TaskOptions	表示任务选项的类型。

getFunctions(应用)

获取默认应用或给定应用的 Functions 服务。

可以在不使用任何参数的情况下调用 getFunctions()，以访问默认应用的 Functions 服务；也可以作为 getFunctions(app) 调用，以便访问与特定应用关联的 Functions 服务。

签名：

export declare function getFunctions(app?: App): Functions;

参数

参数	类型	说明
应用	应用	可选应用，为其返回 Functions 服务。如果未提供，则返回默认的 Functions 服务。

返回：

函数

如果未提供任何应用，则为默认的 Functions 服务，或与所提供的应用关联的 Functions 服务。

示例 1

// Get the `Functions` service for the default app
const defaultFunctions = getFunctions();

示例 2

// Get the `Functions` service for a given app
const otherFunctions = getFunctions(otherApp);

投放时间安排

表示投放时间安排选项的类型。DeliverySchedule 是 DelayDelivery 和 AbsoluteDelivery 类型的联合类型。

签名：

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

TaskOptions

表示任务选项的类型。

签名：

export type TaskOptions = DeliverySchedule & TaskOptionsExperimental & {
    dispatchDeadlineSeconds?: number;
    id?: string;
    headers?: Record<string, string>;
};