Interface FirebaseConfig

interface FirebaseConfig {
    firebase:
        | null
        | {
            analytics?: { enabled?: boolean };
            appCheck: { isTokenAutoRefreshEnabled?: boolean; siteKey?: string };
            auth: {
                facebook: boolean;
                github: boolean;
                google: boolean;
                languageCode?: string;
                persistence?: boolean;
                settings?: AuthSettings;
                tenantId?: string;
                twitter: boolean;
                useDeviceLanguage?: boolean;
            };
            emulator: {
                auth?: [string, number];
                firestore?: [string, number];
                functions?: [string, number];
            };
            firestore: {
                enablePersistence: boolean;
                persistenceSettings: PersistenceSettings;
                settings: FirestoreSettings;
            };
            functions: { origin: null
            | string; region: null | string };
            messaging: { vapid: null | string };
            name: null | string;
            options: {
                apiKey: string;
                appId?: string;
                authDomain?: string;
                databaseURL?: string;
                messagingSenderId?: string;
                projectId: string;
                storageBucket?: string;
            };
            origin: null
            | string;
            region: null | string;
            storage: {
                bucket?: string;
                maxOperationRetryTime?: number;
                maxUploadRetryTime?: number;
            };
            storageBucket: null
            | string;
            vapid: null | string;
        };
}

Properties

Properties

firebase:
    | null
    | {
        analytics?: { enabled?: boolean };
        appCheck: { isTokenAutoRefreshEnabled?: boolean; siteKey?: string };
        auth: {
            facebook: boolean;
            github: boolean;
            google: boolean;
            languageCode?: string;
            persistence?: boolean;
            settings?: AuthSettings;
            tenantId?: string;
            twitter: boolean;
            useDeviceLanguage?: boolean;
        };
        emulator: {
            auth?: [string, number];
            firestore?: [string, number];
            functions?: [string, number];
        };
        firestore: {
            enablePersistence: boolean;
            persistenceSettings: PersistenceSettings;
            settings: FirestoreSettings;
        };
        functions: { origin: null
        | string; region: null | string };
        messaging: { vapid: null | string };
        name: null | string;
        options: {
            apiKey: string;
            appId?: string;
            authDomain?: string;
            databaseURL?: string;
            messagingSenderId?: string;
            projectId: string;
            storageBucket?: string;
        };
        origin: null
        | string;
        region: null | string;
        storage: {
            bucket?: string;
            maxOperationRetryTime?: number;
            maxUploadRetryTime?: number;
        };
        storageBucket: null
        | string;
        vapid: null | string;
    }

Type declaration

  • null
  • {
        analytics?: { enabled?: boolean };
        appCheck: { isTokenAutoRefreshEnabled?: boolean; siteKey?: string };
        auth: {
            facebook: boolean;
            github: boolean;
            google: boolean;
            languageCode?: string;
            persistence?: boolean;
            settings?: AuthSettings;
            tenantId?: string;
            twitter: boolean;
            useDeviceLanguage?: boolean;
        };
        emulator: {
            auth?: [string, number];
            firestore?: [string, number];
            functions?: [string, number];
        };
        firestore: {
            enablePersistence: boolean;
            persistenceSettings: PersistenceSettings;
            settings: FirestoreSettings;
        };
        functions: { origin: null
        | string; region: null | string };
        messaging: { vapid: null | string };
        name: null | string;
        options: {
            apiKey: string;
            appId?: string;
            authDomain?: string;
            databaseURL?: string;
            messagingSenderId?: string;
            projectId: string;
            storageBucket?: string;
        };
        origin: null
        | string;
        region: null | string;
        storage: {
            bucket?: string;
            maxOperationRetryTime?: number;
            maxUploadRetryTime?: number;
        };
        storageBucket: null
        | string;
        vapid: null | string;
    }
    • Optionalanalytics?: { enabled?: boolean }
    • appCheck: { isTokenAutoRefreshEnabled?: boolean; siteKey?: string }
      • OptionalisTokenAutoRefreshEnabled?: boolean
      • OptionalsiteKey?: string

        reCaptcha key

    • auth: {
          facebook: boolean;
          github: boolean;
          google: boolean;
          languageCode?: string;
          persistence?: boolean;
          settings?: AuthSettings;
          tenantId?: string;
          twitter: boolean;
          useDeviceLanguage?: boolean;
      }
    • emulator: {
          auth?: [string, number];
          firestore?: [string, number];
          functions?: [string, number];
      }
    • firestore: {
          enablePersistence: boolean;
          persistenceSettings: PersistenceSettings;
          settings: FirestoreSettings;
      }
      • enablePersistence: boolean
      • persistenceSettings: PersistenceSettings

        Settings that can be passed to Firestore.enablePersistence() to configure Firestore persistence.

      • settings: FirestoreSettings

        Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.

    • functions: { origin: null | string; region: null | string }
    • messaging: { vapid: null | string }
    • name: null | string
    • options: {
          apiKey: string;
          appId?: string;
          authDomain?: string;
          databaseURL?: string;
          messagingSenderId?: string;
          projectId: string;
          storageBucket?: string;
      }
    • origin: null | string

      use functions.origin

    • region: null | string

      use functions.region

    • storage: { bucket?: string; maxOperationRetryTime?: number; maxUploadRetryTime?: number }
    • storageBucket: null | string

      use storage.bucket

    • vapid: null | string

      use messaging.origin