功能
功能 | 描述 |
---|---|
配置() | 存储和检索项目配置数据,例如第三方 API 密钥或其他设置。您可以使用 Firebase CLI 设置配置值,如[环境配置](/docs/functions/config-env)中所述。 |
选项到端点(选项) | |
触发选项(选项) | |
地区(地区) | 配置功能部署到的区域。 |
runWith(运行时选项) | 配置函数的运行时选项。 |
课程
班级 | 描述 |
---|---|
改变 | 用于更改状态的事件的 Cloud Functions 接口,例如实时数据库或 Cloud Firestore onWrite 和onUpdate 事件。有关用于构造Change 对象的格式的更多信息,请参见下文。 |
函数生成器 |
接口
界面 | 描述 |
---|---|
阻塞功能 | 身份验证阻止触发器的功能类型。 |
云函数 | 所有非 HTTPS 触发器的函数类型。这应该从您的 JavaScript 文件导出以定义云函数。这种类型是一个特殊的 JavaScript 函数,它将模板化的Event 对象作为其唯一的参数。 |
部署选项 | 在功能部署期间应用的功能的配置选项。 |
事件 | 事件的有线格式。 |
事件上下文 | 事件发生的上下文。 |
失败策略 | 后台功能故障策略的配置选项。 |
Https函数 | HTTPS 触发器的函数类型。这应该从您的 JavaScript 文件导出以定义云函数。 |
资源 | Resource 是定义资源的标准格式 (google.rpc.context.AttributeContext.Resource)。在 Cloud Functions 中,它是触发函数的资源 - 例如存储桶。 |
可运行 | Runnable 有一个run 方法,它直接调用用户定义的函数 - 对于单元测试很有用。 |
运行时选项 | 在运行时适用的函数的配置选项。 |
日程 | 预定功能的配置选项。 |
计划重试配置 | 调度程序重试选项。仅适用于预定功能。 |
命名空间
命名空间 | 描述 |
---|---|
分析 | |
授权 | |
数据库 | |
火库 | |
https | |
记录器 | |
参数 | |
发布订阅 | |
远程配置 | |
贮存 | |
任务 | |
测试实验室 |
变量
多变的 | 描述 |
---|---|
应用程序 | |
DEFAULT_FAILURE_POLICY | |
INGRESS_SETTINGS_OPTIONS | IngressSettings 的可用选项列表。 |
MAX_NUMBER_USER_LABELS 个 | |
最大超时秒数 | Cloud Functions 最大超时值。 |
MIN_TIMEOUT_SECONDS | Cloud Functions 最短超时值。 |
重置值 | 用于将配置重置为平台默认值的特殊配置值。 |
支持的_地区 | Cloud Functions 支持的所有区域的列表。 |
VALID_MEMORY_OPTIONS | Cloud Functions 支持的可用内存选项列表。 |
VPC_EGRESS_SETTINGS_OPTIONS | VpcConnectorEgressSettings 的可用选项列表。 |
配置()
存储和检索项目配置数据,例如第三方 API 密钥或其他设置。您可以使用 Firebase CLI 设置配置值,如[环境配置](/docs/functions/config-env)中所述。
签名:
export declare function config(): Record<string, any>;
返回:
记录<字符串,任意>
optionsToEndpoint()
签名:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
参数
范围 | 类型 | 描述 |
---|---|---|
选项 | 部署选项 |
返回:
清单端点
选项触发()
签名:
export declare function optionsToTrigger(options: DeploymentOptions): any;
参数
范围 | 类型 | 描述 |
---|---|---|
选项 | 部署选项 |
返回:
任何
地区()
配置功能部署到的区域。
签名:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
参数
范围 | 类型 | 描述 |
---|---|---|
地区 | 数组 <( SUPPORTED_REGIONS类型)[数量] |字符串 |表达<字符串> |重置值> | 更多区域字符串之一。 |
返回:
实施例1
函数.region('us-east1')
实施例2
函数.region('us-east1', 'us-central1')
运行()
配置函数的运行时选项。
签名:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
参数
范围 | 类型 | 描述 |
---|---|---|
运行时选项 | 运行时选项 | 具有可选字段的对象: 1. memory :分配给函数的内存量,可能的值为:'128MB'、'256MB'、'512MB'、'1GB'、'2GB'、'4GB' 和 '8GB' 。 2. timeoutSeconds :函数的超时时间,单位为秒,可能的值为 0 到 540。 3. failurePolicy :函数的失败策略,boolean true 相当于提供一个空的重试对象。 4. vpcConnector :同项目同地域的VPC连接器的id。 5. vpcConnectorEgressSettings :设置 vpcConnector 时,控制通过 vpcConnector 发送哪些出口流量。 6. serviceAccount :该功能的特定服务帐户。 7. ingressSettings :函数的入口设置,控制从何处调用 HTTPS 函数。值不能为空。 |
返回:
应用程序
签名:
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
最大超时秒数
Cloud Functions 最大超时值。
签名:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Cloud Functions 最短超时值。
签名:
MIN_TIMEOUT_SECONDS = 0
重置值
用于将配置重置为平台默认值的特殊配置值。
签名:
RESET_VALUE: ResetValue
支持的_地区
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"]