建構單元測試

Cloud Firestore

Cloud Firestore

RulesTestEnvironment.clearFirestore() => Promise<void>

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

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

這個方法會為此測試內容取得 Firestore 例項。傳回的 Firebase JS Client SDK 例項可搭配用戶端 SDK API (第 9 版模組化或第 9 版相容性) 使用。

Realtime Database

Realtime Database

RulesTestEnvironment.clearDatabase() => Promise<void>

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

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

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

Cloud Storage

Cloud Storage

RulesTestEnvironment.clearStorage() => Promise<void>

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

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

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

Cloud Firestore

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

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

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

這個方法會傳回一個承諾，如果輸入內容成功，則會遭到拒絕，如果輸入內容遭到拒絕，則會成功。可用來斷言資料庫讀取或寫入作業是否失敗。

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

assertSucceeds(pr: 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

傳回的應許會在輸入成功時遭到拒絕，在輸入遭到拒絕時則會成功。

您可以使用這項方法，斷言資料庫讀取或寫入作業失敗：

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

assertSucceeds(pr: Promise) => Promise

傳回的承諾會在輸入內容成功時成功，在輸入內容遭到拒絕時遭到拒絕。

可用於斷言資料庫讀取或寫入作業是否成功：

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

Cloud Storage

Cloud Storage

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

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

傳回已初始化的 Firebase 應用程式，該應用程式會對應至選項中指定的儲存值區名稱和驗證變數覆寫值。

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

initializeAdminApp({ storageBucket: string }) => FirebaseApp

您可以使用此方法建立以管理員身分驗證的應用程式，以便設定測試狀態。

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

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

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

您可以使用這個值來設定儲存值區的規則。

將規則傳送至本機管理的儲存空間值區。接收指定「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

傳回的承諾會在輸入內容成功時遭到拒絕，在輸入內容遭到拒絕時則會成功。

可用於斷言儲存值區的讀取或寫入作業失敗：

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

assertSucceeds(pr: Promise) => Promise

傳回承諾，如果輸入內容成功，則傳回成功，如果輸入內容遭到拒絕，則傳回遭拒絕。

使用這項方法，可斷言儲存值區的讀取或寫入作業是否成功：

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

Cloud Firestore

Cloud Firestore

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

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

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

這個方法會傳回一個承諾，如果輸入內容成功，則會遭到拒絕，如果輸入內容遭到拒絕，則會成功。可用來斷言資料庫讀取或寫入作業是否失敗。

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

assertSucceeds(pr: 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

傳回的應許會在輸入成功時遭到拒絕，在輸入遭到拒絕時則會成功。

您可以使用這項方法，斷言資料庫讀取或寫入作業失敗：

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

assertSucceeds(pr: Promise) => Promise

傳回的承諾會在輸入內容成功時成功，在輸入內容遭到拒絕時遭到拒絕。

可用於斷言資料庫讀取或寫入作業是否成功：

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

Cloud Storage

Cloud Storage

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

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

傳回已初始化的 Firebase 應用程式，該應用程式會對應至選項中指定的儲存值區名稱和驗證變數覆寫值。

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

initializeAdminApp({ storageBucket: string }) => FirebaseApp

您可以使用此方法建立以管理員身分驗證的應用程式，以便設定測試狀態。

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

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

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

您可以使用這個值來設定儲存值區的規則。

將規則傳送至本機管理的儲存空間值區。接收指定「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

傳回的承諾會在輸入內容成功時遭到拒絕，在輸入內容遭到拒絕時則會成功。

可用於斷言儲存值區的讀取或寫入作業失敗：

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

assertSucceeds(pr: Promise) => Promise

傳回承諾，如果輸入內容成功，則傳回成功，如果輸入內容遭到拒絕，則傳回遭拒絕。

使用這項方法，斷言儲存值區的讀取或寫入作業是否成功：

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