@rxap/firebase
Version:
This package provides Angular modules and services to integrate with Firebase, including App Check, Messaging, and Storage. It offers providers for configuring Firebase options and emulators, as well as an HTTP interceptor for App Check. The package also
228 lines (115 loc) • 6.01 kB
Markdown
[**@rxap/firebase v19.0.4**](../README.md)
***
[@rxap/firebase](../globals.md) / FirebaseConfig
# Interface: FirebaseConfig
Defined in: [firebase.config.ts:7](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/firebase/src/lib/firebase.config.ts#L7)
## Properties
### firebase
> **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`; \}
Defined in: [firebase.config.ts:8](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/firebase/src/lib/firebase.config.ts#L8)
#### 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`; \}
#### analytics?
> `optional` **analytics**: `object`
##### analytics.enabled?
> `optional` **enabled**: `boolean`
#### appCheck
> **appCheck**: `object`
##### appCheck.isTokenAutoRefreshEnabled?
> `optional` **isTokenAutoRefreshEnabled**: `boolean`
##### appCheck.siteKey?
> `optional` **siteKey**: `string`
reCaptcha key
#### auth
> **auth**: `object`
##### auth.facebook
> **facebook**: `boolean`
##### auth.github
> **github**: `boolean`
##### auth.google
> **google**: `boolean`
##### auth.languageCode?
> `optional` **languageCode**: `string`
##### auth.persistence?
> `optional` **persistence**: `boolean`
##### auth.settings?
> `optional` **settings**: `AuthSettings`
##### auth.tenantId?
> `optional` **tenantId**: `string`
##### auth.twitter
> **twitter**: `boolean`
##### auth.useDeviceLanguage?
> `optional` **useDeviceLanguage**: `boolean`
#### emulator
> **emulator**: `object`
##### emulator.auth?
> `optional` **auth**: \[`string`, `number`\]
##### emulator.firestore?
> `optional` **firestore**: \[`string`, `number`\]
##### emulator.functions?
> `optional` **functions**: \[`string`, `number`\]
#### firestore
> **firestore**: `object`
##### firestore.enablePersistence
> **enablePersistence**: `boolean`
##### firestore.persistenceSettings
> **persistenceSettings**: `PersistenceSettings`
Settings that can be passed to Firestore.enablePersistence() to configure
Firestore persistence.
##### firestore.settings
> **settings**: `FirestoreSettings`
Specifies custom configurations for your Cloud Firestore instance.
You must set these before invoking any other methods.
#### functions
> **functions**: `object`
##### functions.origin
> **origin**: `null` \| `string`
##### functions.region
> **region**: `null` \| `string`
#### messaging
> **messaging**: `object`
##### messaging.vapid
> **vapid**: `null` \| `string`
#### name
> **name**: `null` \| `string`
#### options
> **options**: `object`
##### options.apiKey
> **apiKey**: `string`
##### options.appId?
> `optional` **appId**: `string`
##### options.authDomain?
> `optional` **authDomain**: `string`
##### options.databaseURL?
> `optional` **databaseURL**: `string`
##### options.messagingSenderId?
> `optional` **messagingSenderId**: `string`
##### options.projectId
> **projectId**: `string`
##### options.storageBucket?
> `optional` **storageBucket**: `string`
#### ~~origin~~
> **origin**: `null` \| `string`
##### Deprecated
use functions.origin
#### ~~region~~
> **region**: `null` \| `string`
##### Deprecated
use functions.region
#### storage
> **storage**: `object`
##### storage.bucket?
> `optional` **bucket**: `string`
##### storage.maxOperationRetryTime?
> `optional` **maxOperationRetryTime**: `number`
##### storage.maxUploadRetryTime?
> `optional` **maxUploadRetryTime**: `number`
#### ~~storageBucket~~
> **storageBucket**: `null` \| `string`
##### Deprecated
use storage.bucket
#### ~~vapid~~
> **vapid**: `null` \| `string`
##### Deprecated
use messaging.origin