Skip to content

Commit

Permalink
Check in generated docs to git (#7025)
Browse files Browse the repository at this point in the history
  • Loading branch information
hsubox76 committed Feb 10, 2023
1 parent 4b44553 commit f741ac1
Show file tree
Hide file tree
Showing 200 changed files with 24,937 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@ packages/**/docs
tsdoc-metadata.json

# generated html docs
docs-*/
docs-rut/
docs/
toc/
35 changes: 35 additions & 0 deletions docs-devsite/analytics.analytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# Analytics interface
An instance of Firebase Analytics.

<b>Signature:</b>

```typescript
export interface Analytics
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [app](./analytics.analytics.md#analyticsapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Analytics](./analytics.analytics.md#analytics_interface) instance is associated with. |

## Analytics.app

The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Analytics](./analytics.analytics.md#analytics_interface) instance is associated with.

<b>Signature:</b>

```typescript
app: FirebaseApp;
```
35 changes: 35 additions & 0 deletions docs-devsite/analytics.analyticscalloptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# AnalyticsCallOptions interface
Additional options that can be passed to Analytics method calls such as `logEvent`<!-- -->, etc.

<b>Signature:</b>

```typescript
export interface AnalyticsCallOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [global](./analytics.analyticscalloptions.md#analyticscalloptionsglobal) | boolean | If true, this config or event call applies globally to all Google Analytics properties on the page. |

## AnalyticsCallOptions.global

If true, this config or event call applies globally to all Google Analytics properties on the page.

<b>Signature:</b>

```typescript
global: boolean;
```
35 changes: 35 additions & 0 deletions docs-devsite/analytics.analyticssettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# AnalyticsSettings interface
[Analytics](./analytics.analytics.md#analytics_interface) instance initialization options.

<b>Signature:</b>

```typescript
export interface AnalyticsSettings
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [config](./analytics.analyticssettings.md#analyticssettingsconfig) | [GtagConfigParams](./analytics.gtagconfigparams.md#gtagconfigparams_interface) \| [EventParams](./analytics.eventparams.md#eventparams_interface) | Params to be passed in the initial <code>gtag</code> config call during Firebase Analytics initialization. |

## AnalyticsSettings.config

Params to be passed in the initial `gtag` config call during Firebase Analytics initialization.

<b>Signature:</b>

```typescript
config?: GtagConfigParams | EventParams;
```
79 changes: 79 additions & 0 deletions docs-devsite/analytics.consentsettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# ConsentSettings interface
Consent status settings for each consent type. For more information, see [the GA4 reference documentation for consent state and consent types](https://developers.google.com/tag-platform/tag-manager/templates/consent-apis)<!-- -->.

<b>Signature:</b>

```typescript
export interface ConsentSettings
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [ad\_storage](./analytics.consentsettings.md#consentsettingsad_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to advertising |
| [analytics\_storage](./analytics.consentsettings.md#consentsettingsanalytics_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to analytics (for example, visit duration) |
| [functionality\_storage](./analytics.consentsettings.md#consentsettingsfunctionality_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage that supports the functionality of the website or app such as language settings |
| [personalization\_storage](./analytics.consentsettings.md#consentsettingspersonalization_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage related to personalization such as video recommendations |
| [security\_storage](./analytics.consentsettings.md#consentsettingssecurity_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage related to security such as authentication functionality, fraud prevention, and other user protection. |

## ConsentSettings.ad\_storage

Enables storage, such as cookies, related to advertising

<b>Signature:</b>

```typescript
ad_storage?: ConsentStatusString;
```

## ConsentSettings.analytics\_storage

Enables storage, such as cookies, related to analytics (for example, visit duration)

<b>Signature:</b>

```typescript
analytics_storage?: ConsentStatusString;
```

## ConsentSettings.functionality\_storage

Enables storage that supports the functionality of the website or app such as language settings

<b>Signature:</b>

```typescript
functionality_storage?: ConsentStatusString;
```

## ConsentSettings.personalization\_storage

Enables storage related to personalization such as video recommendations

<b>Signature:</b>

```typescript
personalization_storage?: ConsentStatusString;
```

## ConsentSettings.security\_storage

Enables storage related to security such as authentication functionality, fraud prevention, and other user protection.

<b>Signature:</b>

```typescript
security_storage?: ConsentStatusString;
```
60 changes: 60 additions & 0 deletions docs-devsite/analytics.controlparams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# ControlParams interface
Standard `gtag.js` control parameters. For more information, see [the GA4 reference documentation](https://developers.google.com/gtagjs/reference/ga4-events)<!-- -->.

<b>Signature:</b>

```typescript
export interface ControlParams
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [event\_callback](./analytics.controlparams.md#controlparamsevent_callback) | () =&gt; void | |
| [event\_timeout](./analytics.controlparams.md#controlparamsevent_timeout) | number | |
| [groups](./analytics.controlparams.md#controlparamsgroups) | string \| string\[\] | |
| [send\_to](./analytics.controlparams.md#controlparamssend_to) | string \| string\[\] | |

## ControlParams.event\_callback

<b>Signature:</b>

```typescript
event_callback?: () => void;
```

## ControlParams.event\_timeout

<b>Signature:</b>

```typescript
event_timeout?: number;
```

## ControlParams.groups

<b>Signature:</b>

```typescript
groups?: string | string[];
```

## ControlParams.send\_to

<b>Signature:</b>

```typescript
send_to?: string | string[];
```
19 changes: 19 additions & 0 deletions docs-devsite/analytics.customparams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# CustomParams interface
Any custom params the user may pass to `gtag`<!-- -->.

<b>Signature:</b>

```typescript
export interface CustomParams
```
Loading

0 comments on commit f741ac1

Please sign in to comment.