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