functions package

Firebase 的云功能

功能

功能描述
函数(应用程序,...)
getFunctions(应用程序,regionOrCustomDomain)返回给定应用程序的Functions实例。
函数(函数实例,...)
connectFunctionsEmulator(functionsInstance, 主机, 端口)修改此实例以与 Cloud Functions 模拟器进行通信。注意:必须在使用该实例执行任何操作之前调用此方法。
httpsCallable(函数实例、名称、选项)返回对具有给定名称的可调用 HTTPS 触发器的引用。
httpsCallableFromURL(functionsInstance, url, 选项)返回对具有指定 url 的可调用 HTTPS 触发器的引用。

接口

界面描述
功能一个Functions实例。
函数错误Firebase Functions 客户端 SDK 返回的错误。
HttpsCallableOptions有关如何执行调用的元数据接口。
HttpsCallableResult HttpsCallableResult包装函数调用的单个结果。

类型别名

类型别名描述
函数错误代码Firebase Functions 状态代码集。这些代码与 gRPC 公开的代码相同:https://github.com/grpc/grpc/blob/master/doc/statuscodes.md可能的值: - 'cancelled':操作被取消(通常由调用者取消)。 -“未知”:未知错误或来自不同错误域的错误。 -“无效参数”:客户端指定了无效参数。请注意,这与“失败前提条件”不同。 “invalid-argument”表示无论系统状态如何都有问题的参数(例如无效的字段名称)。 -“超过截止日期”:操作完成之前截止日期已过。对于更改系统状态的操作,即使操作已成功完成,也可能会返回此错误。例如,服务器的成功响应可能会延迟足够长的时间,以致截止日期到期。 -“未找到”:未找到某些请求的文档。 -“已经存在”:我们尝试创建的某些文档已经存在。 - 'permission-denied':调用者没有执行指定操作的权限。 -“资源耗尽”:某些资源已耗尽,可能是每个用户的配额,或者可能是整个文件系统空间不足。 - 'failed-precondition':操作被拒绝,因为系统未处于操作执行所需的状态。 -“已中止”:操作被中止,通常是由于事务中止等并发问题。 -“超出范围”:尝试的操作超出了有效范围。 -“未实现”:操作未实现或不支持/启用。 -“内部”:内部错误。意味着底层系统期望的一些不变量已经被打破。如果您看到其中一个错误,则表明某些内容已严重损坏。 -“不可用”:该服务当前不可用。这很可能是瞬态情况,可以通过退避重试来纠正。 -“数据丢失”:不可恢复的数据丢失或损坏。 -“未经身份验证”:请求没有用于操作的有效身份验证凭据。
函数错误代码核心函数错误代码字符串附加在“functions/”产品前缀之后。有关代码的完整文档,请参阅FunctionsErrorCode
Https可调用对 Google Cloud Functions 中“可调用”HTTP 触发器的引用。

函数(应用程序,...)

getFunctions(应用程序,regionOrCustomDomain)

返回给定应用程序的Functions实例。

签名:

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

参数

范围类型描述
应用程序Firebase应用程序要使用的FirebaseApp
区域或自定义域细绳以下之一: a) 可调用函数所在的区域(例如:us-central1) b) 托管可调用函数的自定义域(例如:https://mydomain.com)

返回:

功能

函数(函数实例,...)

connectFunctionsEmulator(functionsInstance, 主机, 端口)

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

签名:

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

参数

范围类型描述
函数实例功能
主持人细绳模拟器主机(例如:localhost)
港口数字模拟器端口(例如:5001)

返回:

空白

httpsCallable(函数实例、名称、选项)

返回对具有给定名称的可调用 HTTPS 触发器的引用。

签名:

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

参数

范围类型描述
函数实例功能
姓名细绳触发器的名称。
选项HttpsCallableOptions

返回:

Https可调用<请求数据,响应数据>

httpsCallableFromURL(functionsInstance, url, 选项)

返回对具有指定 url 的可调用 HTTPS 触发器的引用。

签名:

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

参数

范围类型描述
函数实例功能
网址细绳触发器的 URL。
选项HttpsCallableOptions

返回:

Https可调用<请求数据,响应数据>

函数错误代码

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

可能的值: - 'cancelled':操作被取消(通常由调用者取消)。 -“未知”:未知错误或来自不同错误域的错误。 -“无效参数”:客户端指定了无效参数。请注意,这与“失败前提条件”不同。 “invalid-argument”表示无论系统状态如何都有问题的参数(例如无效的字段名称)。 -“超过截止日期”:操作完成之前截止日期已过。对于更改系统状态的操作,即使操作已成功完成,也可能会返回此错误。例如,服务器的成功响应可能会延迟足够长的时间,以致截止日期到期。 -“未找到”:未找到某些请求的文档。 -“已经存在”:我们尝试创建的某些文档已经存在。 - 'permission-denied':调用者没有执行指定操作的权限。 -“资源耗尽”:某些资源已耗尽,可能是每个用户的配额,或者可能是整个文件系统空间不足。 - 'failed-precondition':操作被拒绝,因为系统未处于操作执行所需的状态。 -“已中止”:操作被中止,通常是由于事务中止等并发问题。 -“超出范围”:尝试的操作超出了有效范围。 -“未实现”:操作未实现或不支持/启用。 -“内部”:内部错误。意味着底层系统期望的一些不变量已经被打破。如果您看到其中一个错误,则表明某些内容已严重损坏。 -“不可用”:该服务当前不可用。这很可能是瞬态情况,可以通过退避重试来纠正。 -“数据丢失”:不可恢复的数据丢失或损坏。 -“未经身份验证”:请求没有用于操作的有效身份验证凭据。

签名:

export declare type FunctionsErrorCode = `functions/${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';

Https可调用

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

签名:

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