Skip to content

Add reference docs for modular @firebase/app and @firebase/app-types #2964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs-exp/app-types.firebaseapp.automaticdatacollectionenabled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseApp](./app-types.firebaseapp.md) &gt; [automaticDataCollectionEnabled](./app-types.firebaseapp.automaticdatacollectionenabled.md)

## FirebaseApp.automaticDataCollectionEnabled property

The settable config flag for GDPR opt-in/opt-out

<b>Signature:</b>

```typescript
automaticDataCollectionEnabled: boolean;
```
24 changes: 24 additions & 0 deletions docs-exp/app-types.firebaseapp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseApp](./app-types.firebaseapp.md)

## FirebaseApp interface

A FirebaseApp holds the initialization information for a collection of services.

Do not call this constructor directly. Instead, use [initializeApp()](./app.initializeapp.md) to create an app.

<b>Signature:</b>

```typescript
export interface FirebaseApp
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [automaticDataCollectionEnabled](./app-types.firebaseapp.automaticdatacollectionenabled.md) | <code>boolean</code> | The settable config flag for GDPR opt-in/opt-out |
| [name](./app-types.firebaseapp.name.md) | <code>string</code> | The (read-only) name for this app.<!-- -->The default app's name is <code>&quot;[DEFAULT]&quot;</code>. |
| [options](./app-types.firebaseapp.options.md) | <code>FirebaseOptions</code> | The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.initializeapp.md)<!-- -->. |

36 changes: 36 additions & 0 deletions docs-exp/app-types.firebaseapp.name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseApp](./app-types.firebaseapp.md) &gt; [name](./app-types.firebaseapp.name.md)

## FirebaseApp.name property

The (read-only) name for this app.

The default app's name is `"[DEFAULT]"`<!-- -->.

<b>Signature:</b>

```typescript
readonly name: string;
```

## Example 1


```javascript
// The default app's name is "[DEFAULT]"
const app = initializeApp(defaultAppConfig);
console.log(app.name); // "[DEFAULT]"

```

## Example 2


```javascript
// A named app's name is what you provide to initializeApp()
const otherApp = initializeApp(otherAppConfig, "other");
console.log(otherApp.name); // "other"

```

23 changes: 23 additions & 0 deletions docs-exp/app-types.firebaseapp.options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseApp](./app-types.firebaseapp.md) &gt; [options](./app-types.firebaseapp.options.md)

## FirebaseApp.options property

The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.initializeapp.md)<!-- -->.

<b>Signature:</b>

```typescript
readonly options: FirebaseOptions;
```

## Example


```javascript
const app = initializeApp(config);
console.log(app.options.databaseURL === config.databaseURL); // true

```

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseAppConfig](./app-types.firebaseappconfig.md) &gt; [automaticDataCollectionEnabled](./app-types.firebaseappconfig.automaticdatacollectionenabled.md)

## FirebaseAppConfig.automaticDataCollectionEnabled property

<b>Signature:</b>

```typescript
automaticDataCollectionEnabled?: boolean;
```
20 changes: 20 additions & 0 deletions docs-exp/app-types.firebaseappconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseAppConfig](./app-types.firebaseappconfig.md)

## FirebaseAppConfig interface


<b>Signature:</b>

```typescript
export interface FirebaseAppConfig
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [automaticDataCollectionEnabled](./app-types.firebaseappconfig.automaticdatacollectionenabled.md) | <code>boolean</code> | |
| [name](./app-types.firebaseappconfig.name.md) | <code>string</code> | |

11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseappconfig.name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseAppConfig](./app-types.firebaseappconfig.md) &gt; [name](./app-types.firebaseappconfig.name.md)

## FirebaseAppConfig.name property

<b>Signature:</b>

```typescript
name?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.apikey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [apiKey](./app-types.firebaseoptions.apikey.md)

## FirebaseOptions.apiKey property

<b>Signature:</b>

```typescript
apiKey?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.appid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [appId](./app-types.firebaseoptions.appid.md)

## FirebaseOptions.appId property

<b>Signature:</b>

```typescript
appId?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.authdomain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [authDomain](./app-types.firebaseoptions.authdomain.md)

## FirebaseOptions.authDomain property

<b>Signature:</b>

```typescript
authDomain?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.databaseurl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [databaseURL](./app-types.firebaseoptions.databaseurl.md)

## FirebaseOptions.databaseURL property

<b>Signature:</b>

```typescript
databaseURL?: string;
```
26 changes: 26 additions & 0 deletions docs-exp/app-types.firebaseoptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md)

## FirebaseOptions interface


<b>Signature:</b>

```typescript
export interface FirebaseOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [apiKey](./app-types.firebaseoptions.apikey.md) | <code>string</code> | |
| [appId](./app-types.firebaseoptions.appid.md) | <code>string</code> | |
| [authDomain](./app-types.firebaseoptions.authdomain.md) | <code>string</code> | |
| [databaseURL](./app-types.firebaseoptions.databaseurl.md) | <code>string</code> | |
| [measurementId](./app-types.firebaseoptions.measurementid.md) | <code>string</code> | |
| [messagingSenderId](./app-types.firebaseoptions.messagingsenderid.md) | <code>string</code> | |
| [projectId](./app-types.firebaseoptions.projectid.md) | <code>string</code> | |
| [storageBucket](./app-types.firebaseoptions.storagebucket.md) | <code>string</code> | |

11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.measurementid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [measurementId](./app-types.firebaseoptions.measurementid.md)

## FirebaseOptions.measurementId property

<b>Signature:</b>

```typescript
measurementId?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.messagingsenderid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [messagingSenderId](./app-types.firebaseoptions.messagingsenderid.md)

## FirebaseOptions.messagingSenderId property

<b>Signature:</b>

```typescript
messagingSenderId?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.projectid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [projectId](./app-types.firebaseoptions.projectid.md)

## FirebaseOptions.projectId property

<b>Signature:</b>

```typescript
projectId?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/app-types.firebaseoptions.storagebucket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [FirebaseOptions](./app-types.firebaseoptions.md) &gt; [storageBucket](./app-types.firebaseoptions.storagebucket.md)

## FirebaseOptions.storageBucket property

<b>Signature:</b>

```typescript
storageBucket?: string;
```
15 changes: 15 additions & 0 deletions docs-exp/app-types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md)

## app-types package

## Interfaces

| Interface | Description |
| --- | --- |
| [FirebaseApp](./app-types.firebaseapp.md) | A FirebaseApp holds the initialization information for a collection of services.<!-- -->Do not call this constructor directly. Instead, use [initializeApp()](./app.initializeapp.md) to create an app. |
| [FirebaseAppConfig](./app-types.firebaseappconfig.md) | |
| [FirebaseOptions](./app-types.firebaseoptions.md) | |
| [PlatformLoggerService](./app-types.platformloggerservice.md) | |

15 changes: 15 additions & 0 deletions docs-exp/app-types.platformloggerservice.getplatforminfostring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [PlatformLoggerService](./app-types.platformloggerservice.md) &gt; [getPlatformInfoString](./app-types.platformloggerservice.getplatforminfostring.md)

## PlatformLoggerService.getPlatformInfoString() method

<b>Signature:</b>

```typescript
getPlatformInfoString(): string;
```
<b>Returns:</b>

`string`

19 changes: 19 additions & 0 deletions docs-exp/app-types.platformloggerservice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [PlatformLoggerService](./app-types.platformloggerservice.md)

## PlatformLoggerService interface


<b>Signature:</b>

```typescript
export interface PlatformLoggerService
```

## Methods

| Method | Description |
| --- | --- |
| [getPlatformInfoString()](./app-types.platformloggerservice.getplatforminfostring.md) | |

38 changes: 38 additions & 0 deletions docs-exp/app.deleteapp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/app](./app.md) &gt; [deleteApp](./app.deleteapp.md)

## deleteApp() function

Renders this app unusable and frees the resources of all associated services.

<b>Signature:</b>

```typescript
export declare function deleteApp(app: FirebaseApp): Promise<void>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| app | <code>FirebaseApp</code> | |

<b>Returns:</b>

`Promise<void>`

## Example


```javascript
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});

```

Loading