@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

gitlab.com/rxap/packages/packages/angular/firebase

11 lines • 54.5 kB

HTML

View Raw

<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FirebaseConfig | @rxap/firebase - v19.0.4</title><meta name="description" content="Documentation for @rxap/firebase"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rxap/firebase - v19.0.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rxap/firebase</a></li><li><a href="FirebaseConfig.html">FirebaseConfig</a></li></ul><h1>Interface FirebaseConfig</h1></div><div class="tsd-signature">interface FirebaseConfig { <a class="tsd-kind-property" href="FirebaseConfig.html#firebase">firebase</a>: | 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; }; }</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/firebase/src/lib/firebase.config.ts#L7">firebase.config.ts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FirebaseConfig.html#firebase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>firebase</a> </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="firebase" class="tsd-anchor"></a><h3 class="tsd-anchor-link">firebase<a href="#firebase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">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; }</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul><li>null</li><li>{ 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; }<ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code>analytics?: { enabled?: boolean }</h5></li><li class="tsd-parameter"><h5>appCheck: { isTokenAutoRefreshEnabled?: boolean; siteKey?: string }</h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code>isTokenAutoRefreshEnabled?: boolean</h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code>siteKey?: string</h5><div class="tsd-comment tsd-typography">reCaptcha key </div><div class="tsd-comment tsd-typography"></div></li></ul></li><li class="tsd-parameter"><h5>auth: { facebook: boolean; github: boolean; google: boolean; languageCode?: string; persistence?: boolean; settings?: AuthSettings; tenantId?: string; twitter: boolean; useDeviceLanguage?: boolean; }</h5></li><li class="tsd-parameter"><h5>emulator: { auth?: [string, number]; firestore?: [string, number]; functions?: [string, number]; }</h5></li><li class="tsd-parameter"><h5>firestore: { enablePersistence: boolean; persistenceSettings: PersistenceSettings; settings: FirestoreSettings; }</h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>enablePersistence: boolean</h5></li><li class="tsd-parameter"><h5>persistenceSettings: PersistenceSettings</h5><div class="tsd-comment tsd-typography">Settings that can be passed to Firestore.enablePersistence() to configure Firestore persistence. </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5>settings: FirestoreSettings</h5><div class="tsd-comment tsd-typography">Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods. </div><div class="tsd-comment tsd-typography"></div></li></ul></li><li class="tsd-parameter"><h5>functions: { origin: null | string; region: null | string }</h5></li><li class="tsd-parameter"><h5>messaging: { vapid: null | string }</h5></li><li class="tsd-parameter"><h5>name: null | string</h5></li><li class="tsd-parameter"><h5>options: { apiKey: string; appId?: string; authDomain?: string; databaseURL?: string; messagingSenderId?: string; projectId: string; storageBucket?: string; }</h5></li><li class="tsd-parameter"><h5>origin: null | string</h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>use functions.origin </div></div></li><li class="tsd-parameter"><h5>region: null | string</h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>use functions.region </div></div></li><li class="tsd-parameter"><h5>storage: { bucket?: string; maxOperationRetryTime?: number; maxUploadRetryTime?: number }</h5></li><li class="tsd-parameter"><h5>storageBucket: null | string</h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>use storage.bucket </div></div></li><li class="tsd-parameter"><h5>vapid: null | string</h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-3" class="tsd-anchor"></a>Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>use messaging.origin </div></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/firebase/src/lib/firebase.config.ts#L8">firebase.config.ts:8</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility">Member Visibility<ul id="t