firebase-functions package

适用于 Cloud Functions for Firebase 的第 2 代 API。此 SDK 支持深度导入。例如，命名空间 pubsub 可在 firebase-functions/v2 获得，也可直接从 firebase-functions/v2/pubsub 导入。

函数

函数	说明
setGlobalOptions(options)	为使用第 2 代 SDK 编写的所有函数设置默认选项。

类

类	说明
更改	用于更改状态的事件（例如 Realtime Database 或 Cloud Firestore onWrite 和 onUpdate 事件）的 Cloud Functions 接口。如需详细了解用于构建 Change 对象的格式，请参阅下文。

接口

接口	说明
CloudEvent	（Beta 版）CloudEventBase 是对无服务器事件进行编码的跨平台格式的基础。如需了解详情，请参阅 https://github.com/cloudevents/spec。
Cloud Functions	（Beta 版）CloudEvents 的处理程序。
EventHandlerOptions	可针对任何事件处理函数设置的其他字段。
GlobalOptions	GlobalOptions 是可在整个项目中设置的选项。这些选项是 HTTPS 和事件处理函数通用的选项。

命名空间

命名空间	说明
提醒
数据库
eventarc
firestore
https
身份
日志记录器
参数
发布/订阅
remoteConfig
调度器
存储空间
任务
testLab

类型别名

类型别名	说明
IngressSetting	IngressSettings 的可用选项列表。
内存选项	Cloud Functions 支持的可用内存选项列表。
ParamsOf	一种类型，用于将所有参数捕获 gcloud 映射到记录的键。例如 ParamsOf<"users/{uid}">是 { uid: string } ParamsOf<"users/{uid}/logs/{log}">是 { uid: string;log: string } ParamsOf<"some/static/data">为 {}出于灵活性方面的考虑，ParamsOf 为 Record<string, string>
SupportedRegion	Cloud Functions (第 2 代) 支持的所有区域的列表。
VpcegressSetting	VpcConnectorEgressSettings 的可用选项列表。

setGlobalOptions()

为使用第 2 代 SDK 编写的所有函数设置默认选项。

签名：

export declare function setGlobalOptions(options: GlobalOptions): void;

参数

参数	类型	说明
选项	GlobalOptions	可设为默认卡的选项

返回：

void

入站流量设置

“IngressSettings”的可用选项列表。

签名：

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

内存选项

Cloud Functions 支持的可用内存选项列表。

签名：

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

参数

一种类型，用于将所有参数捕获 gcloud 映射到记录的键。例如 ParamsOf<"users/{uid}">是 { uid: string } ParamsOf<"users/{uid}/logs/{log}">是 { uid: string;log: string } ParamsOf<"some/static/data">为 {}

考虑到灵活性，ParamsOf 为 Record<string, string>

签名：

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

支持区域

Cloud Functions (第 2 代) 支持的所有区域的列表。

签名：

export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";

VpcegressSetting

“VpcConnectorEgressSettings”的可用选项列表。

签名：

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";