functions package

Cloud Functions for Firebase

函数

函数 说明
function(应用, ...)
getFunctions(应用, 区域或自定义域名) 返回给定应用的 Functions 实例。
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, host, port) 请修改此实例以与 Cloud Functions 模拟器进行通信。注意：在使用此实例执行任何操作之前，必须调用此方法。
httpsCallable(functionsInstance, name, options) 返回对具有指定名称的 Callable HTTPS 触发器的引用。
httpsCallableFrom网址(functionsInstance, url, options) 返回对具有指定网址的 Callable HTTPS 触发器的引用。

接口

接口 说明
函数 一个 Functions 实例。
函数错误 Firebase Functions 客户端 SDK 返回的错误。
HttpsCallableOptions 包含有关如何执行调用的元数据的接口。
HttpsCallableResult HttpsCallableResult 会封装来自函数调用的单个结果。

类型别名

类型别名 说明
FunctionsErrorCode 值 Firebase Functions 状态代码集。这些代码与 gRPC 在此处公开的代码相同：https://github.com/grpc/grpc/blob/master/doc/statuscodes.md可能的值：-“cancelled”：操作已取消（通常是被调用方取消）。-“未知”：未知错误或来自其他错误域的错误。- 'invalid- arguments'：客户端指定的参数无效。请注意，这与“failed-precondition”不同。“无效参数”表示无论系统状态如何，都会有问题的参数（例如无效的字段名称）。- 'deadline-exceeded'：截止期限已过，操作还未完成。对于更改系统状态的操作，即使操作已成功完成，也可能会返回此错误。例如，服务器的成功响应延迟时间过长，截止期限已过。-“not-found”：未找到所请求的某些文档。- “ already-exists”：我们尝试创建的某个文档已存在。-“permission-denied”：调用方没有执行指定操作的权限。-“resource-exhausted”：部分资源已用尽，可能是每个用户的配额不足，也可能是因为整个文件系统空间不足。- 'failed-precondition'：操作被拒绝，因为系统未处于执行操作所需的状态。- “aborted”：操作被取消，通常是由于事务中止等并发问题。-“超出范围”：尝试操作超出了有效范围。-“未实现”：操作未实现或不受支持/启用。-“internal”：内部错误。这意味着底层系统所期望的一些不变量已损坏。如果您看到上述某个错误，则表明某些地方已损坏。-“unavailable”：服务当前不可用。这很可能是一种暂时情况，可以通过退避重试来纠正。-“data-loss”：不可恢复的数据丢失或损坏。-“unauthenticated”：请求未包含相应操作的有效身份验证凭据。
FunctionsErrorCodeCore 附加在“functions/”之后的函数错误代码字符串商品前缀。如需查看完整的代码文档，请参阅 FunctionsErrorCode。
HttpsCallable 对“Callable”的引用Google Cloud Functions 中的 HTTP 触发器。

function(应用, ...)

getFunctions(应用, 区域或自定义域名)

返回给定应用的 Functions 实例。

签名：

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

参数

参数 类型 说明
应用 FirebaseApp 要使用的 FirebaseApp。
区域或自定义域名 字符串 a) Callable 函数所在的区域（例如 us-central1）b) 托管 Callable 函数的自定义域名（例如 https://mydomain.com）

返回：

函数

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, host, port)

修改此实例以与 Cloud Functions 模拟器进行通信。

签名：

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

参数

参数 类型 说明
functionsInstance 函数
主机 字符串 模拟器主机（例如：localhost）
端口 数字 模拟器端口（例如：5001）

返回：

void

httpsCallable(functionsInstance, name, options)

返回对具有指定名称的 Callable HTTPS 触发器的引用。

签名：

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

参数

参数 类型 说明
functionsInstance 函数
名称 字符串 触发器的名称。
选项 HttpsCallableOptions

返回：

HttpsCallable<RequestData、ResponseData>

httpsCallableFrom网址(functionsInstance, url, options)

返回对具有指定网址的 Callable HTTPS 触发器的引用。

签名：

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

参数

参数 类型 说明
functionsInstance 函数
网址 字符串 触发器的网址。
选项 HttpsCallableOptions

返回：

HttpsCallable<RequestData、ResponseData>

FunctionsErrorCode

Firebase Functions 状态代码集。这些代码与 gRPC 在此处公开的代码相同：https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

可能的值：-“cancelled”：操作已取消（通常是被调用方取消）。-“未知”：未知错误或来自其他错误域的错误。- 'invalid- arguments'：客户端指定的参数无效。请注意，这与“failed-precondition”不同。“无效参数”表示无论系统状态如何，都会有问题的参数（例如无效的字段名称）。- 'deadline-exceeded'：截止期限已过，操作还未完成。对于更改系统状态的操作，即使操作已成功完成，也可能会返回此错误。例如，服务器的成功响应延迟时间过长，截止期限已过。-“not-found”：未找到所请求的某些文档。- “ already-exists”：我们尝试创建的某个文档已存在。-“permission-denied”：调用方没有执行指定操作的权限。-“resource-exhausted”：部分资源已用尽，可能是每个用户的配额不足，也可能是因为整个文件系统空间不足。- 'failed-precondition'：操作被拒绝，因为系统未处于执行操作所需的状态。- “aborted”：操作被取消，通常是由于事务中止等并发问题。-“超出范围”：尝试操作超出了有效范围。-“未实现”：操作未实现或不受支持/启用。-“internal”：内部错误。这意味着底层系统所期望的一些不变量已损坏。如果您看到上述某个错误，则表明某些地方已损坏。-“unavailable”：服务当前不可用。这很可能是一种暂时情况，可以通过退避重试来纠正。-“data-loss”：不可恢复的数据丢失或损坏。-“unauthenticated”：请求未包含相应操作的有效身份验证凭据。

签名：

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunctionsErrorCodeCore

附加在“functions/”之后的函数错误代码字符串商品前缀。如需查看完整的代码文档，请参阅 FunctionsErrorCode。

签名：

export declare type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

HttpsCallable

对“Callable”的引用Google Cloud Functions 中的 HTTP 触发器。

签名：

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;