@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
1,840 lines • 71.5 kB
HTML
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-firebase</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">angular-firebase</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content miscellaneous-functions">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Miscellaneous</li>
<li class="breadcrumb-item">Functions</li>
</ol>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#AnalyticsEnabledFactory" title="src/lib/firebase.provider.ts" ><b>AnalyticsEnabledFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AppCheckEnabledFactory" title="src/lib/firebase.provider.ts" ><b>AppCheckEnabledFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AppCheckSiteKeyFactory" title="src/lib/firebase.provider.ts" ><b>AppCheckSiteKeyFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AppIsTokenAutoRefreshEnabledFactory" title="src/lib/firebase.provider.ts" ><b>AppIsTokenAutoRefreshEnabledFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AuthLanguageCodeFactory" title="src/lib/firebase.provider.ts" ><b>AuthLanguageCodeFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AuthPersistenceFactory" title="src/lib/firebase.provider.ts" ><b>AuthPersistenceFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AuthSettingsFactory" title="src/lib/firebase.provider.ts" ><b>AuthSettingsFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AuthTenantIdFactory" title="src/lib/firebase.provider.ts" ><b>AuthTenantIdFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#AuthUseDeviceLanguageFactory" title="src/lib/firebase.provider.ts" ><b>AuthUseDeviceLanguageFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#DataCollectionEnabledFactory" title="src/lib/firebase.provider.ts" ><b>DataCollectionEnabledFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#EnablePersistenceTokenFactory" title="src/lib/firebase.provider.ts" ><b>EnablePersistenceTokenFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#FirebaseNameOrConfigTokenFactory" title="src/lib/firebase.provider.ts" ><b>FirebaseNameOrConfigTokenFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#FirebaseOptionsTokenFactory" title="src/lib/firebase.provider.ts" ><b>FirebaseOptionsTokenFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#FirestoreSettingsTokenFactory" title="src/lib/firebase.provider.ts" ><b>FirestoreSettingsTokenFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#FunctionsNewOriginBehaviorFactory" title="src/lib/firebase.provider.ts" ><b>FunctionsNewOriginBehaviorFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#FunctionsOriginFactory" title="src/lib/firebase.provider.ts" ><b>FunctionsOriginFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#FunctionsRegionFactory" title="src/lib/firebase.provider.ts" ><b>FunctionsRegionFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#GetAnalyticsAppName" title="src/lib/firebase.provider.ts" ><b>GetAnalyticsAppName</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#initGenerator" title="src/generators/init/generator.ts" ><b>initGenerator</b> (src/.../generator.ts)</a>
</li>
<li>
<a href="#InstrumentationEnabledFactory" title="src/lib/firebase.provider.ts" ><b>InstrumentationEnabledFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#PersistenceSettingsTokenFactory" title="src/lib/firebase.provider.ts" ><b>PersistenceSettingsTokenFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#ServiceWorkerFactory" title="src/lib/firebase.provider.ts" ><b>ServiceWorkerFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#StorageBucketFactory" title="src/lib/firebase.provider.ts" ><b>StorageBucketFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#StorageMaxOperationRetryTimeFactory" title="src/lib/firebase.provider.ts" ><b>StorageMaxOperationRetryTimeFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#StorageMaxUploadRetryTimeFactory" title="src/lib/firebase.provider.ts" ><b>StorageMaxUploadRetryTimeFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#UseAuthEmulatorFactory" title="src/lib/firebase.provider.ts" ><b>UseAuthEmulatorFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#UseFirestoreEmulatorFactory" title="src/lib/firebase.provider.ts" ><b>UseFirestoreEmulatorFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#UseFunctionsEmulatorFactory" title="src/lib/firebase.provider.ts" ><b>UseFunctionsEmulatorFactory</b> (src/.../firebase.provider.ts)</a>
</li>
<li>
<a href="#VapidKeyFactory" title="src/lib/firebase.provider.ts" ><b>VapidKeyFactory</b> (src/.../firebase.provider.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/lib/firebase.provider.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AnalyticsEnabledFactory"></a>
<span class="name">
<span ><b>AnalyticsEnabledFactory</b></span>
<a href="#AnalyticsEnabledFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AnalyticsEnabledFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AppCheckEnabledFactory"></a>
<span class="name">
<span ><b>AppCheckEnabledFactory</b></span>
<a href="#AppCheckEnabledFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AppCheckEnabledFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AppCheckSiteKeyFactory"></a>
<span class="name">
<span ><b>AppCheckSiteKeyFactory</b></span>
<a href="#AppCheckSiteKeyFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AppCheckSiteKeyFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AppIsTokenAutoRefreshEnabledFactory"></a>
<span class="name">
<span ><b>AppIsTokenAutoRefreshEnabledFactory</b></span>
<a href="#AppIsTokenAutoRefreshEnabledFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AppIsTokenAutoRefreshEnabledFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AuthLanguageCodeFactory"></a>
<span class="name">
<span ><b>AuthLanguageCodeFactory</b></span>
<a href="#AuthLanguageCodeFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AuthLanguageCodeFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AuthPersistenceFactory"></a>
<span class="name">
<span ><b>AuthPersistenceFactory</b></span>
<a href="#AuthPersistenceFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AuthPersistenceFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AuthSettingsFactory"></a>
<span class="name">
<span ><b>AuthSettingsFactory</b></span>
<a href="#AuthSettingsFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AuthSettingsFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AuthTenantIdFactory"></a>
<span class="name">
<span ><b>AuthTenantIdFactory</b></span>
<a href="#AuthTenantIdFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AuthTenantIdFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AuthUseDeviceLanguageFactory"></a>
<span class="name">
<span ><b>AuthUseDeviceLanguageFactory</b></span>
<a href="#AuthUseDeviceLanguageFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AuthUseDeviceLanguageFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="DataCollectionEnabledFactory"></a>
<span class="name">
<span ><b>DataCollectionEnabledFactory</b></span>
<a href="#DataCollectionEnabledFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>DataCollectionEnabledFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="EnablePersistenceTokenFactory"></a>
<span class="name">
<span ><b>EnablePersistenceTokenFactory</b></span>
<a href="#EnablePersistenceTokenFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>EnablePersistenceTokenFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="FirebaseNameOrConfigTokenFactory"></a>
<span class="name">
<span ><b>FirebaseNameOrConfigTokenFactory</b></span>
<a href="#FirebaseNameOrConfigTokenFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>FirebaseNameOrConfigTokenFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="FirebaseOptionsTokenFactory"></a>
<span class="name">
<span ><b>FirebaseOptionsTokenFactory</b></span>
<a href="#FirebaseOptionsTokenFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>FirebaseOptionsTokenFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="FirestoreSettingsTokenFactory"></a>
<span class="name">
<span ><b>FirestoreSettingsTokenFactory</b></span>
<a href="#FirestoreSettingsTokenFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>FirestoreSettingsTokenFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="FunctionsNewOriginBehaviorFactory"></a>
<span class="name">
<span ><b>FunctionsNewOriginBehaviorFactory</b></span>
<a href="#FunctionsNewOriginBehaviorFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>FunctionsNewOriginBehaviorFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="FunctionsOriginFactory"></a>
<span class="name">
<span ><b>FunctionsOriginFactory</b></span>
<a href="#FunctionsOriginFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>FunctionsOriginFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="FunctionsRegionFactory"></a>
<span class="name">
<span ><b>FunctionsRegionFactory</b></span>
<a href="#FunctionsRegionFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>FunctionsRegionFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="GetAnalyticsAppName"></a>
<span class="name">
<span ><b>GetAnalyticsAppName</b></span>
<a href="#GetAnalyticsAppName"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>GetAnalyticsAppName(config: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>config</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>string | undefined</code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="InstrumentationEnabledFactory"></a>
<span class="name">
<span ><b>InstrumentationEnabledFactory</b></span>
<a href="#InstrumentationEnabledFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>InstrumentationEnabledFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="PersistenceSettingsTokenFactory"></a>
<span class="name">
<span ><b>PersistenceSettingsTokenFactory</b></span>
<a href="#PersistenceSettingsTokenFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>PersistenceSettingsTokenFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ServiceWorkerFactory"></a>
<span class="name">
<span ><b>ServiceWorkerFactory</b></span>
<a href="#ServiceWorkerFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ServiceWorkerFactory()</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="StorageBucketFactory"></a>
<span class="name">
<span ><b>StorageBucketFactory</b></span>
<a href="#StorageBucketFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>StorageBucketFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="StorageMaxOperationRetryTimeFactory"></a>
<span class="name">
<span ><b>StorageMaxOperationRetryTimeFactory</b></span>
<a href="#StorageMaxOperationRetryTimeFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>StorageMaxOperationRetryTimeFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="StorageMaxUploadRetryTimeFactory"></a>
<span class="name">
<span ><b>StorageMaxUploadRetryTimeFactory</b></span>
<a href="#StorageMaxUploadRetryTimeFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>StorageMaxUploadRetryTimeFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="UseAuthEmulatorFactory"></a>
<span class="name">
<span ><b>UseAuthEmulatorFactory</b></span>
<a href="#UseAuthEmulatorFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>UseAuthEmulatorFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="UseFirestoreEmulatorFactory"></a>
<span class="name">
<span ><b>UseFirestoreEmulatorFactory</b></span>
<a href="#UseFirestoreEmulatorFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>UseFirestoreEmulatorFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="UseFunctionsEmulatorFactory"></a>
<span class="name">
<span ><b>UseFunctionsEmulatorFactory</b></span>
<a href="#UseFunctionsEmulatorFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>UseFunctionsEmulatorFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="VapidKeyFactory"></a>
<span class="name">
<span ><b>VapidKeyFactory</b></span>
<a href="#VapidKeyFactory"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>VapidKeyFactory(configService: ConfigService)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>configService</td>
<td>
<code>ConfigService</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/generators/init/generator.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="initGenerator"></a>
<span class="name">
<span ><b>initGenerator</b></span>
<a href="#initGenerator"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>initGenerator(tree: Tree, options: InitGeneratorSchema)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>tree</td>
<td>
<code>Tree</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code>InitGeneratorSchema</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'miscellaneous-functions';
var COMPODOC_CURRENT_PAGE_URL = 'functions.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>