命名空間：測試

測試

名稱空間

test是一個全域命名空間，用作 firebase-functions 的測試伴侶。

使用test()初始化 SDK，可以選擇提供以下參數以進行線上測試：

  • firebaseConfig Firebase 配置值，用於初始化 Firebase 應用程式以供測試程式碼與之互動（例如進行資料庫寫入）。建議您使用專門用於測試的項目。如果省略，則使用模擬配置值，並且您的測試不會與真正的 Firebase 應用程式交互，並且所有 Firebase 方法都需要存根。
  • pathToServiceAccountKey初始化 Firebase 應用時要使用的服務帳戶金鑰檔案的路徑。

例如：

const test = require('firebase-functions-test')(); // Offline mode

const test = require('firebase-functions-test')(firebaseConfigValues, path/to/key.json'); // Online mode

介面

命名空間

方法

清理

靜止的

清理（​​）

完成清理任務。

進行更改

靜止的

makeChange（之前，之後）回傳對象

建立一個Change對象，用作 Firestore 和即時資料庫onWrite和onUpdate函數的測試資料。

範圍

前

目的

寫入或更新之前的快照。

值不能為空。

後

目的

寫入或更新後的快照。

值不能為空。

退貨

non-null Object用於測試的Change物件。

模擬配置

靜止的

模擬配置（配置）

由functions.config()傳回的模擬值。

範圍

配置

目的

代表要模擬的配置的鍵值對。

值不能為空。

裹

靜止的

wrap(cloudFunction) 回傳test.WrappedFunction

接受一個要測試的函數，並傳回一個可以在測試程式碼中呼叫的WrappedFunction 。

範圍

雲函數

目的

CloudFunction 既是在 __trigger 處匯出其觸發器定義的對象，也可以使用 Google Cloud Functions 的 JavaScript API 作為函數進行呼叫。

值不能為空。

退貨

non-null test.WrappedFunction

包裝函數

靜止的

包裝函數（數據，選項）

可以使用事件上下文的測試資料和可選覆蓋值來呼叫的函數類型。隨後它將呼叫它用提供的測試資料和產生的事件上下文包裝的函數。

範圍

數據

任何類型

測試數據。

值不能為空。

選項

目的

將事件上下文的值覆寫為EventContextOptions物件。

值可能為空。