Cloud Functions for Firebase
函式
| 函式 | 說明 |
|---|---|
| 功能(應用程式, ...) | |
| getFunctions(應用程式, regionOrCustomDomain) | 傳回指定應用程式的函式執行個體。 |
| function(functionsInstance, ...) | |
| connectFunctionsEmulator(functionsInstance, 主機, 通訊埠) | 修改這個執行個體，與 Cloud Functions 模擬器通訊。注意：在使用這個執行個體執行任何作業之前，必須先呼叫這個執行個體。 |
| httpsCallable(函式執行個體, 名稱, 選項) | 傳回具有指定名稱的可呼叫 HTTPS 觸發條件參照。 |
| httpsCallableFromURL(functionsInstance, url, options) | 傳回具有指定網址的可呼叫 HTTPS 觸發條件參照。 |
介面
| 介面 | 說明 |
|---|---|
| 函式 | Functions 執行個體。 |
| FunctionsError | Firebase Functions 用戶端 SDK 傳回錯誤。 |
| HttpsCallableOptions | 應如何執行呼叫的中繼資料介面。 |
| HttpsCallableResult | HttpsCallableResult 會納入函式呼叫中的單一結果。 |
型別別名
| 類型別名 | 說明 |
|---|---|
| FunctionsErrorCode | Firebase Functions 狀態碼組合。這些代碼與 gRPC 所公開的代碼相同：https://github.com/grpc/grpc/blob/master/doc/statuscodes.md可能的值：- 'cancelled'：作業已取消 (通常是呼叫端)。-「未知」：未知的錯誤或其他錯誤網域的錯誤。-「 invalid-argument」：用戶端指定的引數無效。請注意，這與「failed-precondition」不同。「無效引數」會指出無論系統狀態為何有問題的引數 (例如無效欄位名稱)。-「超過期限」：在作業完成前已過期。針對變更系統狀態的作業，即使作業已成功完成，也可能傳回此錯誤。例如，伺服器雖然成功回應，但延遲時間太久，因而超過期限。-「找不到」：找不到某些要求的文件。-「已存在」：一些我們嘗試建立的文件已經存在。-「權限遭拒」：呼叫者沒有執行指定作業的權限。-「資源用盡」：已耗盡某些資源，也許是每位使用者的配額，或是整個檔案系統空間不足。-「failed-precondition」：由於系統未處於執行作業所需的狀態，因此作業遭拒。-「已中止」：作業已取消，通常是因為交易取消等並行問題所導致。-「超出範圍」：嘗試執行的作業超出有效範圍。-「未實作」：未執行或不支援/未啟用作業。-「internal」：發生內部錯誤。意味著基礎系統預期的某些不變量已被破壞。如果看到這類錯誤，表示已經完全損壞。-「無法使用」：目前無法使用服務。這很可能是一個暫時的情況，並可透過重試輪詢來修正。-「data-loss」：無法復原的資料遺失或損毀。-「unauthenticated」：要求沒有作業的有效驗證憑證。 |
| FunctionsErrorCodeCore | 「functions/」後方附加的函式錯誤代碼字串產品前置字元。如需程式碼的完整說明文件，請參閱 FunctionsErrorCode。 |
| HttpsCallable | 「可呼叫」的參照Google Cloud Functions 中的 HTTP 觸發條件。 |
function(應用程式, ...)
getFunctions(應用程式, regionOrCustomDomain)
傳回指定應用程式的函式執行個體。
簽名：
export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | Firebase 應用程式 | 要使用的 FirebaseApp。 |
| 區域或自訂網域 | 字串 | 下列其中一個：a) 可呼叫函式所在的區域 (例如：us-central1) b) 代管可呼叫函式的自訂網域 (例如 https://mydomain.com) |
傳回：
function(functionsInstance, ...)
ConnectFunctionsEmulator(functionsInstance, 主機, 通訊埠)
修改這個執行個體，與 Cloud Functions 模擬器通訊。
簽名：
export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 函式執行個體 | 函式 | |
| 主機 | 字串 | 模擬器主機 (例如：localhost) |
| 通訊埠 | 數字 | 模擬器通訊埠 (例如：5001) |
傳回：
void
httpsCallable(函式執行個體, 名稱, 選項)
傳回具有指定名稱的可呼叫 HTTPS 觸發條件參照。
簽名：
export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 函式執行個體 | 函式 | |
| 名稱 | 字串 | 觸發條件的名稱。 |
| 選項 | HttpsCallableOptions |
傳回：
HttpsCallable<RequestData, ResponseData>
httpsCallableFromURL(函式執行個體, 網址, 選項)
傳回具有指定網址的可呼叫 HTTPS 觸發條件參照。
簽名：
export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 函式執行個體 | 函式 | |
| 網址 | 字串 | 觸發條件的網址。 |
| 選項 | HttpsCallableOptions |
傳回：
HttpsCallable<RequestData, ResponseData>
FunctionsErrorCode
Firebase Functions 狀態碼組合。這些代碼與 gRPC 所公開的程式碼相同：https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
可能的值：-「cancelled」：作業已取消 (通常是呼叫端)。-「未知」：未知的錯誤或其他錯誤網域的錯誤。-「 invalid-argument」：用戶端指定的引數無效。請注意，這與「failed-precondition」不同。「無效引數」會指出無論系統狀態為何有問題的引數 (例如無效欄位名稱)。-「超過期限」：在作業完成前已過期。針對變更系統狀態的作業，即使作業已成功完成，也可能傳回此錯誤。例如，伺服器雖然成功回應，但延遲時間太久，因而超過期限。-「找不到」：找不到某些要求的文件。-「已存在」：一些我們嘗試建立的文件已經存在。-「權限遭拒」：呼叫者沒有執行指定作業的權限。-「資源用盡」：已耗盡某些資源，也許是每位使用者的配額，或是整個檔案系統空間不足。-「failed-precondition」：由於系統未處於執行作業所需的狀態，因此作業遭拒。-「已中止」：作業已取消，通常是因為交易取消等並行問題所導致。-「超出範圍」：嘗試執行的作業超出有效範圍。-「未實作」：未執行或不支援/未啟用作業。-「internal」：發生內部錯誤。意味著基礎系統預期的某些不變量已被破壞。如果看到這類錯誤，表示已經完全損壞。-「無法使用」：目前無法使用服務。這很可能是一個暫時的情況，並可透過重試輪詢來修正。-「data-loss」：無法復原的資料遺失或損毀。-「unauthenticated」：要求沒有作業的有效驗證憑證。
簽名：
export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
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';
HttpsCallable
「可呼叫」的參照Google Cloud Functions 中的 HTTP 觸發條件。
簽名：
export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;