Skip to content

Commit 2da892e

Browse files
hsubox76hsubox76
committed
get docs, update docgen script
1 parent 60cff59 commit 2da892e

File tree

203 files changed

+24969
-15
lines changed

Some content is hidden

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

203 files changed

+24969
-15
lines changed

‎.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,4 @@ scripts/docgen/content-sources/ @egilmorez @firebase/jssdk-global-approvers
9999
docs-devsite/ @egilmorez @markarndt
100100

101101
# Changeset
102-
.changeset @egilmorez @firebase/jssdk-changeset-approvers @firebase/firestore-js-team @firebase/jssdk-global-approvers
102+
.changeset @firebase/jssdk-changeset-approvers @firebase/firestore-js-team @firebase/jssdk-global-approvers

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

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,14 @@ export class AuthCredential {
103103
protected constructor(
104104
providerId: string,
105105
signInMethod: string);
106-
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
107-
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
106+
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
107+
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
108108
//
109109
// @internal (undocumented)
110110
_getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
111111
// @internal (undocumented)
112112
_getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
113-
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
113+
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
114114
//
115115
// @internal (undocumented)
116116
_linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
@@ -283,6 +283,9 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
283283
disableWarnings: boolean;
284284
}): void;
285285

286+
// @public
287+
export const cordovaPopupRedirectResolver: PopupRedirectResolver;
288+
286289
// @public
287290
export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
288291

@@ -346,7 +349,7 @@ export interface EmulatorConfig {
346349

347350
export { ErrorFn }
348351

349-
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
352+
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
350353
//
351354
// @public
352355
export class FacebookAuthProvider extends BaseOAuthProvider {
@@ -381,6 +384,9 @@ export function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<Id
381384
// @public
382385
export function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
383386

387+
// @public
388+
export function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;
389+
384390
// @public
385391
export function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
386392

@@ -490,7 +496,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
490496
export class OAuthCredential extends AuthCredential {
491497
accessToken?: string;
492498
static fromJSON(json: string | object): OAuthCredential | null;
493-
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
499+
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
494500
//
495501
// @internal (undocumented)
496502
static _fromParams(params: OAuthCredentialParams): OAuthCredential;
@@ -568,7 +574,7 @@ export class PhoneAuthCredential extends AuthCredential {
568574
_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
569575
// @internal (undocumented)
570576
_linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
571-
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
577+
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
572578
//
573579
// @internal (undocumented)
574580
_makeVerificationRequest(): SignInWithPhoneNumberRequest;
@@ -647,6 +653,9 @@ export interface ReactNativeAsyncStorage {
647653
setItem(key: string, value: string): Promise<void>;
648654
}
649655

656+
// @public
657+
export const reactNativeLocalPersistence: Persistence;
658+
650659
// @public
651660
export function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
652661

@@ -665,13 +674,13 @@ export interface RecaptchaParameters {
665674
[key: string]: any;
666675
}
667676

668-
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
677+
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
669678
//
670679
// @public
671680
export class RecaptchaVerifier implements ApplicationVerifierInternal {
672681
constructor(containerOrId: HTMLElement | string, parameters: RecaptchaParameters, authExtern: Auth);
673682
clear(): void;
674-
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
683+
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
675684
//
676685
// @internal (undocumented)
677686
readonly _recaptchaLoader: ReCaptchaLoader;
@@ -685,7 +694,7 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
685694
// @public
686695
export function reload(user: User): Promise<void>;
687696

688-
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
697+
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
689698
//
690699
// @public
691700
export class SAMLAuthProvider extends FederatedAuthProvider {

‎docs-devsite/analytics.analytics.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# Analytics interface
13+
An instance of Firebase Analytics.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface Analytics
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [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. |
26+
27+
## Analytics.app
28+
29+
The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Analytics](./analytics.analytics.md#analytics_interface) instance is associated with.
30+
31+
<b>Signature:</b>
32+
33+
```typescript
34+
app: FirebaseApp;
35+
```

‎docs-devsite/analytics.analyticscalloptions.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# AnalyticsCallOptions interface
13+
Additional options that can be passed to Analytics method calls such as `logEvent`<!-- -->, etc.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface AnalyticsCallOptions
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [global](./analytics.analyticscalloptions.md#analyticscalloptionsglobal) | boolean | If true, this config or event call applies globally to all Google Analytics properties on the page. |
26+
27+
## AnalyticsCallOptions.global
28+
29+
If true, this config or event call applies globally to all Google Analytics properties on the page.
30+
31+
<b>Signature:</b>
32+
33+
```typescript
34+
global: boolean;
35+
```

‎docs-devsite/analytics.analyticssettings.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# AnalyticsSettings interface
13+
[Analytics](./analytics.analytics.md#analytics_interface) instance initialization options.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface AnalyticsSettings
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [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. |
26+
27+
## AnalyticsSettings.config
28+
29+
Params to be passed in the initial `gtag` config call during Firebase Analytics initialization.
30+
31+
<b>Signature:</b>
32+
33+
```typescript
34+
config?: GtagConfigParams | EventParams;
35+
```

‎docs-devsite/analytics.consentsettings.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ConsentSettings interface
13+
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)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface ConsentSettings
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [ad\_storage](./analytics.consentsettings.md#consentsettingsad_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to advertising |
26+
| [analytics\_storage](./analytics.consentsettings.md#consentsettingsanalytics_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to analytics (for example, visit duration) |
27+
| [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 |
28+
| [personalization\_storage](./analytics.consentsettings.md#consentsettingspersonalization_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage related to personalization such as video recommendations |
29+
| [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. |
30+
31+
## ConsentSettings.ad\_storage
32+
33+
Enables storage, such as cookies, related to advertising
34+
35+
<b>Signature:</b>
36+
37+
```typescript
38+
ad_storage?: ConsentStatusString;
39+
```
40+
41+
## ConsentSettings.analytics\_storage
42+
43+
Enables storage, such as cookies, related to analytics (for example, visit duration)
44+
45+
<b>Signature:</b>
46+
47+
```typescript
48+
analytics_storage?: ConsentStatusString;
49+
```
50+
51+
## ConsentSettings.functionality\_storage
52+
53+
Enables storage that supports the functionality of the website or app such as language settings
54+
55+
<b>Signature:</b>
56+
57+
```typescript
58+
functionality_storage?: ConsentStatusString;
59+
```
60+
61+
## ConsentSettings.personalization\_storage
62+
63+
Enables storage related to personalization such as video recommendations
64+
65+
<b>Signature:</b>
66+
67+
```typescript
68+
personalization_storage?: ConsentStatusString;
69+
```
70+
71+
## ConsentSettings.security\_storage
72+
73+
Enables storage related to security such as authentication functionality, fraud prevention, and other user protection.
74+
75+
<b>Signature:</b>
76+
77+
```typescript
78+
security_storage?: ConsentStatusString;
79+
```

‎docs-devsite/analytics.controlparams.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ControlParams interface
13+
Standard `gtag.js` control parameters. For more information, see [the GA4 reference documentation](https://developers.google.com/gtagjs/reference/ga4-events)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface ControlParams
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [event\_callback](./analytics.controlparams.md#controlparamsevent_callback) | () =&gt; void | |
26+
| [event\_timeout](./analytics.controlparams.md#controlparamsevent_timeout) | number | |
27+
| [groups](./analytics.controlparams.md#controlparamsgroups) | string \| string\[\] | |
28+
| [send\_to](./analytics.controlparams.md#controlparamssend_to) | string \| string\[\] | |
29+
30+
## ControlParams.event\_callback
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
event_callback?: () => void;
36+
```
37+
38+
## ControlParams.event\_timeout
39+
40+
<b>Signature:</b>
41+
42+
```typescript
43+
event_timeout?: number;
44+
```
45+
46+
## ControlParams.groups
47+
48+
<b>Signature:</b>
49+
50+
```typescript
51+
groups?: string | string[];
52+
```
53+
54+
## ControlParams.send\_to
55+
56+
<b>Signature:</b>
57+
58+
```typescript
59+
send_to?: string | string[];
60+
```

‎docs-devsite/analytics.customparams.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# CustomParams interface
13+
Any custom params the user may pass to `gtag`<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface CustomParams
19+
```

0 commit comments

Comments
 (0)