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