https namespace

功能

功能描述
onCall(处理程序)声明可供客户端使用 Firebase SDK 调用的可调用方法。
onRequest(处理程序)处理 HTTP 请求。

课程

班级描述
Https错误可以从处理程序引发的显式错误,以将错误发送到调用该函数的客户端。

接口

界面描述
可调用上下文传递给处理程序的 API 元数据的接口。
要求具有请求正文的有线格式表示的明确请求。

类型别名

类型别名描述
函数错误代码Firebase Functions 状态代码集。代码与gRPC公开的代码相同

https.onCall()

声明可供客户端使用 Firebase SDK 调用的可调用方法。

签名:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

参数

范围类型描述
处理程序(数据:任意,上下文: CallableContext ) => 任意 |承诺<任何>一种接受数据和上下文并返回值的方法。

返回:

Https 函数可运行<任何>

https.onRequest()

处理 HTTP 请求。

签名:

export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;

参数

范围类型描述
处理程序(req:请求,resp:express.Response)=> void |承诺<无效>一个接受请求和响应对象的函数,其签名与 Express 应用程序相同。

返回:

Https函数

https.FunctionsErrorCode

Firebase Functions 状态代码集。代码与gRPC公开的代码相同

可能的值:

  • cancelled :操作被取消(通常由调用者取消)。

  • unknown :未知错误或来自不同错误域的错误。

  • invalid-argument :客户端指定了无效参数。请注意,这与failed-precondition不同invalid-argument表示无论系统状态如何都有问题的参数(例如无效的字段名称)。

  • deadline-exceeded :截止日期已过,操作无法完成。对于更改系统状态的操作,即使操作已成功完成,也可能会返回此错误。例如,服务器的成功响应可能会延迟足够长的时间,以致截止日期到期。

  • not-found :未找到某些请求的文件。

  • already-exists :我们尝试创建的一些文档已经存在。

  • permission-denied : 调用者没有执行指定操作的权限。

  • resource-exhausted :某些资源已耗尽,可能是每个用户的配额,或者可能是整个文件系统空间不足。

  • failed-precondition :操作被拒绝,因为系统未处于操作执行所需的状态。

  • aborted :操作被中止,通常是由于事务中止等并发问题。

  • out-of-range :尝试超出有效范围进行操作。

  • unimplemented :操作未实现或不支持/启用。

  • internal :内部错误。意味着底层系统期望的一些不变量已经被打破。如果您看到其中一个错误,则表明某些内容已严重损坏。

  • unavailable : 该服务目前不可用。这很可能是瞬态情况,可以通过退避重试来纠正。

  • data-loss :不可恢复的数据丢失或损坏。

  • unauthenticated :请求没有用于操作的有效身份验证凭据。

签名:

export type FunctionsErrorCode = "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";