函数
| 函数 | 说明 |
|---|---|
| config() | 存储和检索项目配置数据，例如第三方 API 密钥或其他设置。您可以按照 [环境配置](/docs/functions/config-env)中的说明使用 Firebase CLI 设置配置值。 |
| optionsToEndpoint(options) | |
| optionsToTrigger(options) | |
| region [地区] | 配置要在其中部署函数的区域。 |
| runWith(runtimeOptions) | 为函数配置运行时选项。 |
类
| 类 | 说明 |
|---|---|
| 更改 | 用于更改状态的事件（例如 Realtime Database 或 Cloud Firestore onWrite 和 onUpdate 事件）的 Cloud Functions 接口。如需详细了解用于构建 Change 对象的格式，请参阅下文。 |
| FunctionBuilder |
接口
| 接口 | 说明 |
|---|---|
| 屏蔽函数 | Auth 屏蔽触发器的函数类型。 |
| Cloud Functions | 适用于所有非 HTTPS 触发器的函数类型。您应从 JavaScript 文件中导出该函数，以定义 Cloud Functions 函数。此类型是一个特殊的 JavaScript 函数，该函数接受模板化 Event 对象作为其唯一参数。 |
| DeploymentOptions | 在函数部署期间应用的函数的配置选项。 |
| 事件 | 事件的电汇格式。 |
| 事件上下文 | 事件发生的上下文。 |
| FailurePolicy | 后台函数的失败政策的配置选项。 |
| HttpsFunction 部分 | HTTPS 触发器的函数类型。您应从 JavaScript 文件导出该文件，以定义 Cloud Functions 函数。 |
| 资源 | Resource 是定义资源 (google.rpc.context.AttributeContext.Resource) 的标准格式。在 Cloud Functions 中，资源就是触发函数的资源，例如存储分区。 |
| 可运行 | Runnable 具有 run 方法，该方法直接调用用户定义的函数，对单元测试非常有用。 |
| RuntimeOptions | 在运行时适用的函数的配置选项。 |
| 时间表 | 预定函数的配置选项。 |
| ScheduleRetryConfig | 调度器重试选项。仅适用于预定函数。 |
命名空间
| 命名空间 | 说明 |
|---|---|
| 分析 | |
| 身份验证 | |
| 数据库 | |
| firestore | |
| https | |
| 日志记录器 | |
| 参数 | |
| 发布/订阅 | |
| remoteConfig | |
| 存储空间 | |
| 任务 | |
| testLab |
变量
| 变量 | 说明 |
|---|---|
| 应用 | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | IngressSettings 的可用选项列表。 |
| MAX_NUMBER_USER_LABELS 个 | |
| MAX_TIMEOUT_SECONDS | Cloud Functions 函数超时值上限。 |
| MIN_TIMEOUT_SECONDS | Cloud Functions 函数超时值下限。 |
| 重置值 | 用于将配置重置为平台默认值的特殊配置值。 |
| SUPPORTED_REGIONS | Cloud Functions 支持的所有区域的列表。 |
| VALID_MEMORY_OPTIONS | Cloud Functions 支持的可用内存选项列表。 |
| VPC_EGRESS_SETTINGS_OPTIONS | VpcConnectoregressSettings 的可用选项列表。 |
config()
存储和检索项目配置数据，例如第三方 API 密钥或其他设置。您可以按照 [环境配置](/docs/functions/config-env)中的说明使用 Firebase CLI 设置配置值。
签名：
export declare function config(): Record<string, any>;
返回：
记录<string, any>
optionsToEndpoint()
签名：
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 选项 | DeploymentOptions |
返回：
ManifestEndpoint
optionsToTrigger()
签名：
export declare function optionsToTrigger(options: DeploymentOptions): any;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 选项 | DeploymentOptions |
返回：
任意
region()
配置要在其中部署函数的区域。
签名：
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 区域 | 数组<(类型 SUPPORTED_REGIONS)[number] |字符串 |表达式<string>|重置值> | 一个或多个区域字符串。 |
返回：
示例 1
functions.region('us-east1')
示例 2
functions.region('us-east1', 'us-central1')
runWith()
为函数配置运行时选项。
签名：
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| runtimeOptions | RuntimeOptions | 包含可选字段的对象：1.memory：要分配给函数的内存量，可能的值包括：“128MB”“256MB”“512MB”“1GB”“2GB”“4GB”和“8GB”。2. timeoutSeconds：函数的超时时间（以秒为单位），可能的值为 0 到 540。3. failurePolicy：函数的失败政策，布尔值 true 相当于提供一个空的重试对象。4. vpcConnector：同一项目和区域中 VPC 连接器的 ID。5. vpcConnectorEgressSettings：设置 vpcConnector 时，控制通过 vpcConnector 发送哪些出站流量。6. serviceAccount：函数的特定服务账号。7. ingressSettings：函数的入站流量设置，用于控制从何处调用 HTTPS 函数。值不得为 null。 |
返回：
应用
签名：
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
签名：
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
IngressSettings 的可用选项列表。
签名：
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABELS 个
签名：
MAX_NUMBER_USER_LABELS = 58
MAX_TIMEOUT_SECONDS 秒
Cloud Functions 函数超时值上限。
签名：
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Cloud Functions 函数超时值下限。
签名：
MIN_TIMEOUT_SECONDS = 0
重置值
用于将配置重置为平台默认值的特殊配置值。
签名：
RESET_VALUE: ResetValue
SUPPORTED_REGIONS
Cloud Functions 支持的所有区域的列表。
签名：
SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]
VALID_MEMORY_OPTIONS
Cloud Functions 支持的可用内存选项的列表。
签名：
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
VpcConnectoregressSettings 的可用选项列表。
签名：
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]