https namespace

函数

函数	说明
onCall(opts, handle)	声明一个 Callable 方法，以供客户端使用 Firebase SDK 进行调用。
onCall(handler)	声明一个 Callable 方法，以供客户端使用 Firebase SDK 进行调用。
onRequest(opts, Handler)	处理 HTTPS 请求。
onRequest(handler)	处理 HTTPS 请求。

类

类	说明
HttpsError	可以从处理程序抛出的显式错误，以向调用函数的客户端发送错误。

接口

接口	说明
CallableFunction	创建一个 Callable 方法，以供客户端使用 Firebase SDK 进行调用。
CallableOptions	可在 Callable HTTPS 函数上设置的选项。
CallableRequest	用于调用 Callable 函数的请求。
HttpsOptions	可在 onRequest HTTPS 函数上设置的选项。
请求	以传输格式表示请求正文的极速请求。

类型别名

类型别名	说明
FunctionsErrorCode 值	Firebase Functions 状态代码集。这些代码与 gRPC 公开的代码相同。
HttpsFunction 部分	处理 HTTPS 请求。

https.onCall()方法

声明一个 Callable 方法，以供客户端使用 Firebase SDK 进行调用。

签名：

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

参数

参数	类型	说明
优化	CallableOptions	为此函数设置的选项。
handler	（请求：CallableRequest<T>）=>返程	一个接受 https.CallableRequest 的函数。

返回：

CallableFunction<T、Return>

您可以导出和部署的函数。

https.onCall()方法

声明一个 Callable 方法，以供客户端使用 Firebase SDK 进行调用。

签名：

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

参数

参数	类型	说明
handler	（请求：CallableRequest<T>）=>返程	一个接受 https.CallableRequest 的函数。

返回：

CallableFunction<T、Return>

您可以导出和部署的函数。

https.onRequest() 中

处理 HTTPS 请求。

签名：

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

参数

参数	类型	说明
优化	HttpsOptions	为此函数设置的选项
handler	（请求：Request，响应：express.Response）=>无效 |承诺<void>	一个接受 https.Request 和响应对象（签名与 Express 应用相同）的函数。

返回：

HttpsFunction 部分

您可以导出和部署的函数。

https.onRequest() 中

处理 HTTPS 请求。

签名：

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

参数

参数	类型	说明
handler	（请求：Request，响应：express.Response）=>无效 |承诺<void>	一个接受 https.Request 和响应对象（签名与 Express 应用相同）的函数。

返回：

HttpsFunction 部分

您可以导出和部署的函数。

https.Functions 错误代码

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";

https.HttpsFunction

处理 HTTPS 请求。

签名：

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};