功能
功能 | 描述 |
---|---|
onCall(選擇,處理程序) | 聲明可供客戶端使用 Firebase SDK 呼叫的可呼叫方法。 |
onCall(處理程序) | 聲明可供客戶端使用 Firebase SDK 呼叫的可呼叫方法。 |
onRequest(選擇,處理程序) | 處理 HTTPS 請求。 |
onRequest(處理程序) | 處理 HTTPS 請求。 |
課程
班級 | 描述 |
---|---|
Https錯誤 | 可以從處理程序引發的明確錯誤,以將錯誤傳送到呼叫函數的用戶端。 |
介面
介面 | 描述 |
---|---|
可呼叫函數 | 建立一個可呼叫方法,供客戶端使用 Firebase SDK 呼叫。 |
可調用選項 | 可以在可呼叫 HTTPS 函數上設定的選項。 |
可調用請求 | 用於呼叫可調用函數的請求。 |
HTTPS選項 | 可以在 onRequest HTTPS 函數上設定的選項。 |
要求 | 具有請求正文的有線格式表示的明確請求。 |
類型別名
類型別名 | 描述 |
---|---|
函數錯誤程式碼 | Firebase Functions 狀態碼集。代碼與gRPC公開的代碼相同。 |
Https函數 | 處理 HTTPS 請求。 |
https.onCall()
聲明可供客戶端使用 Firebase SDK 呼叫的可呼叫方法。
簽名:
export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
參數
範圍 | 類型 | 描述 |
---|---|---|
選擇 | 可調用選項 | 對此功能進行設定的選項。 |
處理程式 | (請求: CallableRequest <T>) => 返回 | 接受https.CallableRequest的函數。 |
返回:
CallableFunction<T, 回傳>
您可以匯出和部署的函數。
https.onCall()
聲明可供客戶端使用 Firebase SDK 呼叫的可呼叫方法。
簽名:
export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
參數
範圍 | 類型 | 描述 |
---|---|---|
處理程式 | (請求: CallableRequest <T>) => 返回 | 接受https.CallableRequest的函數。 |
返回:
CallableFunction<T, 回傳>
您可以匯出和部署的函數。
https.onRequest()
處理 HTTPS 請求。
簽名:
export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
參數
範圍 | 類型 | 描述 |
---|---|---|
選擇 | HTTPS選項 | 在此功能上設定的選項 |
處理程式 | (請求:請求,回應:express.Response) => void |承諾<無效> | 採用https.Request和回應物件的函數,與 Express 應用程式的簽章相同。 |
返回:
您可以匯出和部署的函數。
https.onRequest()
處理 HTTPS 請求。
簽名:
export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
參數
範圍 | 類型 | 描述 |
---|---|---|
處理程式 | (請求:請求,回應:express.Response) => void |承諾<無效> | 採用https.Request和回應物件的函數,與 Express 應用程式的簽章相同。 |
返回:
您可以匯出和部署的函數。
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";
https.HttpsFunction
處理 HTTPS 請求。
簽名:
export type HttpsFunction = ((
req: Request,
res: express.Response) => void | Promise<void>) & {
__trigger?: unknown;
__endpoint: ManifestEndpoint;
};