Skip to content

Commit 4190745

Browse files
Feiyang1Feiyang1
authored
Reference docs for analytics, storage and database exp (#4339)
1 parent 5720387 commit 4190745

File tree

321 files changed

+5417
-95
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

321 files changed

+5417
-95
lines changed

‎common/api-review/analytics-exp.api.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ import { SettingsOptions } from '@firebase/analytics-types-exp';
1717

1818
export { Analytics }
1919

20-
export { AnalyticsCallOptions }
21-
2220
export { ControlParams }
2321

2422
// @public

‎common/api-review/analytics-types-exp.api.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
import { FirebaseApp } from '@firebase/app-types-exp';
88

9+
// @public (undocumented)
10+
export interface Analytics {
11+
app: FirebaseApp;
12+
}
13+
914
// @public
1015
export interface AnalyticsCallOptions {
1116
global: boolean;
@@ -122,6 +127,12 @@ export interface EventParams {
122127
// (undocumented)
123128
number?: string;
124129
// (undocumented)
130+
page_location?: string;
131+
// (undocumented)
132+
page_path?: string;
133+
// (undocumented)
134+
page_title?: string;
135+
// (undocumented)
125136
payment_type?: string;
126137
// (undocumented)
127138
promotion_id?: string;
@@ -145,12 +156,6 @@ export interface EventParams {
145156
value?: number;
146157
}
147158

148-
// @public (undocumented)
149-
export interface FirebaseAnalytics {
150-
// (undocumented)
151-
app: FirebaseApp;
152-
}
153-
154159
// @public
155160
export interface Gtag {
156161
// (undocumented)
@@ -169,9 +174,6 @@ export interface Gtag {
169174
): void;
170175
}
171176

172-
// @public (undocumented)
173-
export type GtagCommand = 'event' | 'set' | 'config';
174-
175177
// @public (undocumented)
176178
export interface Item {
177179
// (undocumented)

‎common/api-review/auth-types-exp.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ export interface Auth {
7878
languageCode: string | null;
7979
readonly name: string;
8080
onAuthStateChanged(
81-
nextOrObserver: NextOrObserver<User>,
81+
nextOrObserver: NextOrObserver<User | null>,
8282
error?: ErrorFn,
8383
completed?: CompleteFn
8484
): Unsubscribe;
8585
onIdTokenChanged(
86-
nextOrObserver: NextOrObserver<User>,
86+
nextOrObserver: NextOrObserver<User | null>,
8787
error?: ErrorFn,
8888
completed?: CompleteFn
8989
): Unsubscribe;

‎common/api-review/database.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ export interface ServerValue {
187187
// @public (undocumented)
188188
export interface ThenableReference
189189
extends Reference,
190-
Pick<Promise<Reference>, 'then' | 'catch'> { }
190+
Pick<Promise<Reference>, 'then' | 'catch'> {}
191191

192192

193193
// (No @packageDocumentation comment for this package)

‎common/api-review/firestore.api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,9 @@ export function updateDoc(reference: DocumentReference<unknown>, data: UpdateDat
460460
// @public
461461
export function updateDoc(reference: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
462462

463+
// @public
464+
export function useFirestoreEmulator(firestore: FirebaseFirestore, host: string, port: number): void;
465+
463466
// @public
464467
export function waitForPendingWrites(firestore: FirebaseFirestore): Promise<void>;
465468

‎common/api-review/firestore.lite.api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,9 @@ export function updateDoc(reference: DocumentReference<unknown>, data: UpdateDat
329329
// @public
330330
export function updateDoc(reference: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
331331

332+
// @public
333+
export function useFirestoreEmulator(firestore: FirebaseFirestore, host: string, port: number): void;
334+
332335
// @public
333336
export function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryConstraint;
334337

‎docs-exp/analytics-types.analytics.app.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [Analytics](./analytics-types.analytics.md) &gt; [app](./analytics-types.analytics.app.md)
4+
5+
## Analytics.app property
6+
7+
The FirebaseApp this Functions instance is associated with.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
app: FirebaseApp;
13+
```

‎docs-exp/analytics-types.analytics.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [Analytics](./analytics-types.analytics.md)
4+
5+
## Analytics interface
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export interface Analytics
11+
```
12+
13+
## Properties
14+
15+
| Property | Type | Description |
16+
| --- | --- | --- |
17+
| [app](./analytics-types.analytics.app.md) | [FirebaseApp](./app-types.firebaseapp.md) | The FirebaseApp this Functions instance is associated with. |
18+

‎docs-exp/analytics-types.analyticscalloptions.global.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [AnalyticsCallOptions](./analytics-types.analyticscalloptions.md) &gt; [global](./analytics-types.analyticscalloptions.global.md)
4+
5+
## AnalyticsCallOptions.global property
6+
7+
If true, this config or event call applies globally to all analytics properties on the page.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
global: boolean;
13+
```

‎docs-exp/analytics-types.analyticscalloptions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [AnalyticsCallOptions](./analytics-types.analyticscalloptions.md)
4+
5+
## AnalyticsCallOptions interface
6+
7+
Additional options that can be passed to Firebase Analytics method calls such as `logEvent`<!-- -->, `setCurrentScreen`<!-- -->, etc.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface AnalyticsCallOptions
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [global](./analytics-types.analyticscalloptions.global.md) | boolean | If true, this config or event call applies globally to all analytics properties on the page. |
20+

‎docs-exp/analytics-types.controlparams.event_callback.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [event\_callback](./analytics-types.controlparams.event_callback.md)
4+
5+
## ControlParams.event\_callback property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
event_callback?: () => void;
11+
```

‎docs-exp/analytics-types.controlparams.event_timeout.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [event\_timeout](./analytics-types.controlparams.event_timeout.md)
4+
5+
## ControlParams.event\_timeout property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
event_timeout?: number;
11+
```

‎docs-exp/analytics-types.controlparams.groups.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [groups](./analytics-types.controlparams.groups.md)
4+
5+
## ControlParams.groups property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
groups?: string | string[];
11+
```

‎docs-exp/analytics-types.controlparams.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md)
4+
5+
## ControlParams interface
6+
7+
Standard gtag.js control parameters. For more information, see [the gtag.js documentation on parameters](https://developers.google.com/gtagjs/reference/parameter)<!-- -->.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface ControlParams
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [event\_callback](./analytics-types.controlparams.event_callback.md) | () =&gt; void | |
20+
| [event\_timeout](./analytics-types.controlparams.event_timeout.md) | number | |
21+
| [groups](./analytics-types.controlparams.groups.md) | string \| string\[\] | |
22+
| [send\_to](./analytics-types.controlparams.send_to.md) | string \| string\[\] | |
23+

‎docs-exp/analytics-types.controlparams.send_to.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [send\_to](./analytics-types.controlparams.send_to.md)
4+
5+
## ControlParams.send\_to property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
send_to?: string | string[];
11+
```

‎docs-exp/analytics-types.currency.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [Currency](./analytics-types.currency.md)
4+
5+
## Currency type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export type Currency = string | number;
11+
```

‎docs-exp/analytics-types.customparams.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [CustomParams](./analytics-types.customparams.md)
4+
5+
## CustomParams interface
6+
7+
Any custom params the user may pass to gtag.js.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface CustomParams
13+
```

‎docs-exp/analytics-types.datalayer.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DataLayer](./analytics-types.datalayer.md)
4+
5+
## DataLayer type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export type DataLayer = Array<IArguments>;
11+
```

‎docs-exp/analytics-types.dynamicconfig.apikey.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [apiKey](./analytics-types.dynamicconfig.apikey.md)
4+
5+
## DynamicConfig.apiKey property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
apiKey: string;
11+
```

‎docs-exp/analytics-types.dynamicconfig.appid.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [appId](./analytics-types.dynamicconfig.appid.md)
4+
5+
## DynamicConfig.appId property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
appId: string;
11+
```

‎docs-exp/analytics-types.dynamicconfig.authdomain.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [authDomain](./analytics-types.dynamicconfig.authdomain.md)
4+
5+
## DynamicConfig.authDomain property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
authDomain: string;
11+
```

‎docs-exp/analytics-types.dynamicconfig.databaseurl.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [databaseURL](./analytics-types.dynamicconfig.databaseurl.md)
4+
5+
## DynamicConfig.databaseURL property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
databaseURL: string;
11+
```

‎docs-exp/analytics-types.dynamicconfig.locationid.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [locationId](./analytics-types.dynamicconfig.locationid.md)
4+
5+
## DynamicConfig.locationId property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
locationId: string;
11+
```

‎docs-exp/analytics-types.dynamicconfig.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md)
4+
5+
## DynamicConfig interface
6+
7+
Dynamic configuration fetched from server. See https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps/getConfig
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface DynamicConfig
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [apiKey](./analytics-types.dynamicconfig.apikey.md) | string | |
20+
| [appId](./analytics-types.dynamicconfig.appid.md) | string | |
21+
| [authDomain](./analytics-types.dynamicconfig.authdomain.md) | string | |
22+
| [databaseURL](./analytics-types.dynamicconfig.databaseurl.md) | string | |
23+
| [locationId](./analytics-types.dynamicconfig.locationid.md) | string | |
24+
| [measurementId](./analytics-types.dynamicconfig.measurementid.md) | string | |
25+
| [messagingSenderId](./analytics-types.dynamicconfig.messagingsenderid.md) | string | |
26+
| [projectId](./analytics-types.dynamicconfig.projectid.md) | string | |
27+
| [storageBucket](./analytics-types.dynamicconfig.storagebucket.md) | string | |
28+

‎docs-exp/analytics-types.dynamicconfig.measurementid.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [measurementId](./analytics-types.dynamicconfig.measurementid.md)
4+
5+
## DynamicConfig.measurementId property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
measurementId: string;
11+
```

‎docs-exp/analytics-types.dynamicconfig.messagingsenderid.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [messagingSenderId](./analytics-types.dynamicconfig.messagingsenderid.md)
4+
5+
## DynamicConfig.messagingSenderId property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
messagingSenderId: string;
11+
```

0 commit comments

Comments
 (0)