TestEnvironmentConfig interface

Configuration of the unit testing environment, including emulators.

Signature:

export interface TestEnvironmentConfig 

Properties

Property Type Description
database EmulatorConfig The Database emulator. Its host and port can also be discovered automatically through the hub (see field "hub") or specified via the environment variable FIREBASE_DATABASE_EMULATOR_HOST.
firestore EmulatorConfig The Firestore emulator. Its host and port can also be discovered automatically through the hub (see field "hub") or specified via the environment variable FIRESTORE_EMULATOR_HOST.
hub HostAndPort The Firebase Emulator hub. Can also be specified via the environment variable FIREBASE_EMULATOR_HUB. If specified either way, other running emulators can be automatically discovered, and thus do not to be explicity specified.
projectId string The project ID of the test environment. Can also be specified via the environment variable GCLOUD_PROJECT.A "demo-*" project ID is strongly recommended, especially for unit testing. See: https://firebase.google.com/docs/emulator-suite/connect_firestore#choose_a_firebase_project
storage EmulatorConfig The Storage emulator. Its host and port can also be discovered automatically through the hub (see field "hub") or specified via the environment variable FIREBASE_STORAGE_EMULATOR_HOST.

TestEnvironmentConfig.database

The Database emulator. Its host and port can also be discovered automatically through the hub (see field "hub") or specified via the environment variable FIREBASE_DATABASE_EMULATOR_HOST.

Signature:

database?: EmulatorConfig;

TestEnvironmentConfig.firestore

The Firestore emulator. Its host and port can also be discovered automatically through the hub (see field "hub") or specified via the environment variable FIRESTORE_EMULATOR_HOST.

Signature:

firestore?: EmulatorConfig;

TestEnvironmentConfig.hub

The Firebase Emulator hub. Can also be specified via the environment variable FIREBASE_EMULATOR_HUB. If specified either way, other running emulators can be automatically discovered, and thus do not to be explicity specified.

Signature:

hub?: HostAndPort;

TestEnvironmentConfig.projectId

The project ID of the test environment. Can also be specified via the environment variable GCLOUD_PROJECT.

A "demo-*" project ID is strongly recommended, especially for unit testing. See: https://firebase.google.com/docs/emulator-suite/connect_firestore#choose_a_firebase_project

Signature:

projectId?: string;

TestEnvironmentConfig.storage

The Storage emulator. Its host and port can also be discovered automatically through the hub (see field "hub") or specified via the environment variable FIREBASE_STORAGE_EMULATOR_HOST.

Signature:

storage?: EmulatorConfig;