建構單元測試

Cloud Firestore

Cloud Firestore

RulesTestEnvironment.clearFirestore() => Promise<void>

這個方法會清除 Firestore 資料庫中屬於 projectId 的資料，這些資料已設定為 Firestore 模擬器。

RulesTestContext.firestore(settings?: Firestore.FirestoreSettings) => Firestore;

這個方法會取得此測試環境的 Firestore 執行個體。傳回的 Firebase JS Client SDK 執行個體可用於 Client SDK API (v9 模組化或 v9 相容)。

Realtime Database

Realtime Database

RulesTestEnvironment.clearDatabase() => Promise<void>

這個方法會清除 Realtime Database 中屬於為 Realtime Database 模擬器設定的 projectId 資料。

RulesTestContext.database(databaseURL?: Firestore.FirestoreSettings) => Firestore;

取得這個測試情境的 Realtime Database 執行個體。傳回的 Firebase JS 用戶端 SDK 執行個體可搭配用戶端 SDK API (模組化或命名空間，版本 9 以上) 使用。這個方法會接受即時資料庫執行個體的網址。如果已指定，則會傳回命名空間模擬版本的執行個體，並從網址中擷取參數。

Cloud Storage

Cloud Storage

RulesTestEnvironment.clearStorage() => Promise<void>

這個方法會清除 projectId 所屬儲存空間值區中的物件和中繼資料，這些值區已為 Cloud Storage 模擬器設定。

RulesTestContext.storage(bucketUrl?: string) => Firebase Storage;

這個方法會傳回設定為連線至模擬器的 Storage 執行個體。這個方法會接受 Firebase Storage Bucket 的 gs:// 網址，以進行測試。如果指定，則會傳回 bucket 名稱模擬版本的 Storage 執行個體。

Cloud Firestore

initializeTestApp({ projectId: string, auth: Object }) => FirebaseApp

這個方法會傳回與選項中指定的專案 ID 和驗證變數對應的已初始化 Firebase 應用程式。您可以使用這個函式建立應用程式，並以特定使用者身分通過驗證，以用於測試。

firebase.initializeTestApp({
  projectId: "my-test-project",
  auth: { uid: "alice", email: "alice@example.com" }
});

initializeAdminApp({ projectId: string }) => FirebaseApp

這個方法會傳回已初始化的管理員 Firebase 應用程式。這個應用程式會在執行讀取和寫入作業時略過安全性規則。您可以使用這個應用程式建立經過管理員驗證的應用程式，以便設定測試狀態。

firebase.initializeAdminApp({ projectId: "my-test-project" });
    

apps() => [FirebaseApp] 這個方法會傳回目前已初始化的所有測試和管理員應用程式。 您可以使用這項功能在測試之間或測試後清除應用程式。

Promise.all(firebase.apps().map(app => app.delete()))

loadFirestoreRules({ projectId: string, rules: Object }) => Promise

這個方法會將規則傳送至在本機執行的資料庫。這個方法會將指定規則的物件做為字串。使用這個方法設定資料庫規則。

firebase.loadFirestoreRules({
  projectId: "my-test-project",
  rules: fs.readFileSync("/path/to/firestore.rules", "utf8")
});
    

assertFails(pr: Promise) => Promise

這個方法會傳回 Promise，如果輸入內容成功，Promise 會遭到拒絕；如果輸入內容遭到拒絕，Promise 則會成功。使用這個函式判斷資料庫讀取或寫入作業是否失敗。

firebase.assertFails(app.firestore().collection("private").doc("super-secret-document").get());
    

assertSucceeds(pr: Promise) => Promise

這個方法會傳回 Promise，如果輸入成功，Promise 就會成功，如果輸入遭拒，Promise 就會遭拒。用來判斷資料庫讀取或寫入作業是否成功。

firebase.assertSucceeds(app.firestore().collection("public").doc("test-document").get());
    

clearFirestoreData({ projectId: string }) => Promise

這個方法會清除在本機執行的 Firestore 執行個體中，與特定專案相關聯的所有資料。使用這個方法可在測試後清除資料。

firebase.clearFirestoreData({
  projectId: "my-test-project"
});
   

Realtime Database

Realtime Database

initializeTestApp({ databaseName: string, auth: Object }) => FirebaseApp

您可以使用這項功能建立已驗證為特定使用者的應用程式，以用於測試。

傳回與選項中指定的資料庫名稱和驗證變數覆寫項目對應的已初始化 Firebase 應用程式。

firebase.initializeTestApp({
  databaseName: "my-database",
  auth: { uid: "alice" }
});

initializeAdminApp({ databaseName: string }) => FirebaseApp

您可以使用這個函式建立經過管理員身分驗證的應用程式，以便為測試設定狀態。

傳回與選項中指定的資料庫名稱對應的已初始化管理員 Firebase 應用程式。這個應用程式在讀取及寫入資料庫時，會略過安全性規則。

firebase.initializeAdminApp({ databaseName: "my-database" });

loadDatabaseRules({ databaseName: string, rules: Object }) => Promise

您可以使用這個選項設定資料庫規則。

將規則傳送至在本機執行的資料庫。這個函式會採用選項物件，以字串形式指定「databaseName」和「rules」。

firebase
      .loadDatabaseRules({
        databaseName: "my-database",
        rules: "{'rules': {'.read': false, '.write': false}}"
      });

apps() => [FirebaseApp]

傳回目前已初始化的所有測試和管理員應用程式。

在測試期間或測試後，使用這個方法清除應用程式 (請注意，如果已初始化應用程式並啟用監聽器，JavaScript 就無法結束)：

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

Returns a promise that is rejected if the input succeeds and succeeds if the input is rejected.

使用這項功能，確認資料庫讀取或寫入作業失敗：

firebase.assertFails(app.database().ref("secret").once("value"));

assertSucceeds(pr: Promise) => Promise

如果輸入成功，則傳回成功的 Promise；如果輸入遭拒，則傳回遭拒的 Promise。

使用這個方法，確認資料庫讀取或寫入作業成功：

firebase.assertSucceeds(app.database().ref("public").once("value"));

Cloud Storage

Cloud Storage

initializeTestApp({ storageBucket: string, auth: Object }) => FirebaseApp

您可以使用這項功能建立已驗證為特定使用者的應用程式，以用於測試。

傳回對應於儲存空間 bucket 名稱的已初始化 Firebase 應用程式，以及選項中指定的驗證變數覆寫。

firebase.initializeTestApp({
  storageBucket: "my-bucket",
  auth: { uid: "alice" }
});

initializeAdminApp({ storageBucket: string }) => FirebaseApp

您可以使用這個函式建立經過管理員身分驗證的應用程式，以便為測試設定狀態。

傳回與選項中指定的儲存空間值區名稱對應的已初始化管理員 Firebase 應用程式。這個應用程式在讀取及寫入 Bucket 時，會略過安全規則。

firebase.initializeAdminApp({ storageBucket: "my-bucket" });

loadStorageRules({ storageBucket: string, rules: Object }) => Promise

您可以使用這項功能設定儲存空間 bucket 的規則。

將規則傳送至本機管理的儲存空間值區。這個函式會採用選項物件，將「storageBucket」和「rules」指定為字串。

firebase
      .loadStorageRules({
        storageBucket: "my-bucket",
        rules: fs.readFileSync("/path/to/storage.rules", "utf8")
      });

apps() => [FirebaseApp]

傳回目前已初始化的所有測試和管理員應用程式。

在測試期間或測試後，使用這個方法清除應用程式 (請注意，如果已初始化應用程式並啟用監聽器，JavaScript 就無法結束)：

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

Returns a promise that is rejected if the input succeeds and succeeds if the input is rejected.

使用這個方法，確認儲存空間值區的讀取或寫入作業失敗：

firebase.assertFails(app.storage().ref("letters/private.doc").getMetadata());

assertSucceeds(pr: Promise) => Promise

Returns a promise that succeeds if the input succeeds and is rejected if the input is rejected.

使用這項功能，確認儲存空間 bucket 的讀取或寫入作業成功：

firebase.assertFails(app.storage().ref("images/cat.png").getMetadata());

Cloud Firestore

Cloud Firestore

initializeTestApp({ projectId: string, auth: Object }) => FirebaseApp

這個方法會傳回與選項中指定的專案 ID 和驗證變數對應的已初始化 Firebase 應用程式。您可以使用這個函式建立應用程式，並以特定使用者身分通過驗證，以用於測試。

firebase.initializeTestApp({
  projectId: "my-test-project",
  auth: { uid: "alice", email: "alice@example.com" }
});

initializeAdminApp({ projectId: string }) => FirebaseApp

這個方法會傳回已初始化的管理員 Firebase 應用程式。這個應用程式會在執行讀取和寫入作業時略過安全性規則。您可以使用這個應用程式建立經過管理員驗證的應用程式，以便設定測試狀態。

firebase.initializeAdminApp({ projectId: "my-test-project" });
    

apps() => [FirebaseApp] 這個方法會傳回目前已初始化的所有測試和管理員應用程式。 您可以使用這項功能在測試之間或測試後清除應用程式。

Promise.all(firebase.apps().map(app => app.delete()))

loadFirestoreRules({ projectId: string, rules: Object }) => Promise

這個方法會將規則傳送至在本機執行的資料庫。這個方法會將指定規則的物件做為字串。使用這個方法設定資料庫規則。

firebase.loadFirestoreRules({
  projectId: "my-test-project",
  rules: fs.readFileSync("/path/to/firestore.rules", "utf8")
});
    

assertFails(pr: Promise) => Promise

這個方法會傳回 Promise，如果輸入內容成功，Promise 會遭到拒絕；如果輸入內容遭到拒絕，Promise 則會成功。使用這個函式判斷資料庫讀取或寫入作業是否失敗。

firebase.assertFails(app.firestore().collection("private").doc("super-secret-document").get());
    

assertSucceeds(pr: Promise) => Promise

這個方法會傳回 Promise，如果輸入成功，Promise 就會成功，如果輸入遭拒，Promise 就會遭拒。用來判斷資料庫讀取或寫入作業是否成功。

firebase.assertSucceeds(app.firestore().collection("public").doc("test-document").get());
    

clearFirestoreData({ projectId: string }) => Promise

這個方法會清除在本機執行的 Firestore 執行個體中，與特定專案相關聯的所有資料。使用這個方法可在測試後清除資料。

firebase.clearFirestoreData({
  projectId: "my-test-project"
});
   

Realtime Database

Realtime Database

initializeTestApp({ databaseName: string, auth: Object }) => FirebaseApp

您可以使用這項功能建立已驗證為特定使用者的應用程式，以用於測試。

傳回與選項中指定的資料庫名稱和驗證變數覆寫項目對應的已初始化 Firebase 應用程式。

firebase.initializeTestApp({
  databaseName: "my-database",
  auth: { uid: "alice" }
});

initializeAdminApp({ databaseName: string }) => FirebaseApp

您可以使用這個函式建立經過管理員身分驗證的應用程式，以便為測試設定狀態。

傳回與選項中指定的資料庫名稱對應的已初始化管理員 Firebase 應用程式。這個應用程式在讀取及寫入資料庫時，會略過安全性規則。

firebase.initializeAdminApp({ databaseName: "my-database" });

loadDatabaseRules({ databaseName: string, rules: Object }) => Promise

您可以使用這個選項設定資料庫規則。

將規則傳送至在本機執行的資料庫。這個函式會採用選項物件，以字串形式指定「databaseName」和「rules」。

firebase
      .loadDatabaseRules({
        databaseName: "my-database",
        rules: "{'rules': {'.read': false, '.write': false}}"
      });

apps() => [FirebaseApp]

傳回目前已初始化的所有測試和管理員應用程式。

在測試期間或測試後，使用這個方法清除應用程式 (請注意，如果已初始化應用程式並啟用監聽器，JavaScript 就無法結束)：

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

Returns a promise that is rejected if the input succeeds and succeeds if the input is rejected.

使用這項功能，確認資料庫讀取或寫入作業失敗：

firebase.assertFails(app.database().ref("secret").once("value"));

assertSucceeds(pr: Promise) => Promise

如果輸入成功，則傳回成功的 Promise；如果輸入遭拒，則傳回遭拒的 Promise。

使用這個方法，確認資料庫讀取或寫入作業成功：

firebase.assertSucceeds(app.database().ref("public").once("value"));

Cloud Storage

Cloud Storage

initializeTestApp({ storageBucket: string, auth: Object }) => FirebaseApp

您可以使用這項功能建立已驗證為特定使用者的應用程式，以用於測試。

傳回對應於儲存空間 bucket 名稱的已初始化 Firebase 應用程式，以及選項中指定的驗證變數覆寫。

firebase.initializeTestApp({
  storageBucket: "my-bucket",
  auth: { uid: "alice" }
});

initializeAdminApp({ storageBucket: string }) => FirebaseApp

您可以使用這個函式建立經過管理員身分驗證的應用程式，以便為測試設定狀態。

傳回與選項中指定的儲存空間值區名稱對應的已初始化管理員 Firebase 應用程式。這個應用程式在讀取及寫入 Bucket 時，會略過安全規則。

firebase.initializeAdminApp({ storageBucket: "my-bucket" });

loadStorageRules({ storageBucket: string, rules: Object }) => Promise

您可以使用這項功能設定儲存空間 bucket 的規則。

將規則傳送至本機管理的儲存空間值區。這個函式會採用選項物件，將「storageBucket」和「rules」指定為字串。

firebase
      .loadStorageRules({
        storageBucket: "my-bucket",
        rules: fs.readFileSync("/path/to/storage.rules", "utf8")
      });

apps() => [FirebaseApp]

傳回目前已初始化的所有測試和管理員應用程式。

在測試期間或測試後，使用這個方法清除應用程式 (請注意，如果已初始化應用程式並啟用監聽器，JavaScript 就無法結束)：

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

Returns a promise that is rejected if the input succeeds and succeeds if the input is rejected.

使用這個方法，確認儲存空間值區的讀取或寫入作業失敗：

firebase.assertFails(app.storage().ref("letters/private.doc").getMetadata());

assertSucceeds(pr: Promise) => Promise

Returns a promise that succeeds if the input succeeds and is rejected if the input is rejected.

使用這項功能，確認儲存空間 bucket 的讀取或寫入作業成功：

firebase.assertFails(app.storage().ref("images/cat.png").getMetadata());