Skip to content

Commit f1bb53c

Browse files
Feiyang1Feiyang1
authored
Merge bb675d4 into b6925be 
2 parents b6925be + bb675d4 commit f1bb53c

File tree

353 files changed

+7375
-18
lines changed

Some content is hidden

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

353 files changed

+7375
-18
lines changed

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

Lines changed: 451 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 557 additions & 0 deletions
Large diffs are not rendered by default.

‎docs-exp/auth-types.actioncodeinfo.data.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeInfo](./auth-types.actioncodeinfo.md) &gt; [data](./auth-types.actioncodeinfo.data.md)
4+
5+
## ActionCodeInfo.data property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
data: {
11+
email?: string | null;
12+
multiFactorInfo?: MultiFactorInfo | null;
13+
previousEmail?: string | null;
14+
};
15+
```

‎docs-exp/auth-types.actioncodeinfo.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeInfo](./auth-types.actioncodeinfo.md)
4+
5+
## ActionCodeInfo interface
6+
7+
https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface ActionCodeInfo
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | |
20+
| [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | |
21+

‎docs-exp/auth-types.actioncodeinfo.operation.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/auth-types](./auth-types.md) &gt; [ActionCodeInfo](./auth-types.actioncodeinfo.md) &gt; [operation](./auth-types.actioncodeinfo.operation.md)
4+
5+
## ActionCodeInfo.operation property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
operation: Operation;
11+
```

‎docs-exp/auth-types.actioncodesettings.android.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [android](./auth-types.actioncodesettings.android.md)
4+
5+
## ActionCodeSettings.android property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
android?: {
11+
installApp?: boolean;
12+
minimumVersion?: string;
13+
packageName: string;
14+
};
15+
```

‎docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md)
4+
5+
## ActionCodeSettings.dynamicLinkDomain property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
dynamicLinkDomain?: string;
11+
```

‎docs-exp/auth-types.actioncodesettings.handlecodeinapp.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md)
4+
5+
## ActionCodeSettings.handleCodeInApp property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
handleCodeInApp?: boolean;
11+
```

‎docs-exp/auth-types.actioncodesettings.ios.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [iOS](./auth-types.actioncodesettings.ios.md)
4+
5+
## ActionCodeSettings.iOS property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
iOS?: {
11+
bundleId: string;
12+
};
13+
```

‎docs-exp/auth-types.actioncodesettings.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md)
4+
5+
## ActionCodeSettings interface
6+
7+
https://firebase.google.com/docs/reference/js/firebase.auth\#actioncodesettings
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface ActionCodeSettings
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | |
20+
| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | |
21+
| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | |
22+
| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | |
23+
| [url](./auth-types.actioncodesettings.url.md) | string | |
24+

‎docs-exp/auth-types.actioncodesettings.url.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [url](./auth-types.actioncodesettings.url.md)
4+
5+
## ActionCodeSettings.url property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
url: string;
11+
```

‎docs-exp/auth-types.actioncodeurl.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [apiKey](./auth-types.actioncodeurl.apikey.md)
4+
5+
## ActionCodeURL.apiKey property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly apiKey: string;
11+
```

‎docs-exp/auth-types.actioncodeurl.code.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [code](./auth-types.actioncodeurl.code.md)
4+
5+
## ActionCodeURL.code property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly code: string;
11+
```

‎docs-exp/auth-types.actioncodeurl.continueurl.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [continueUrl](./auth-types.actioncodeurl.continueurl.md)
4+
5+
## ActionCodeURL.continueUrl property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly continueUrl: string | null;
11+
```

‎docs-exp/auth-types.actioncodeurl.languagecode.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [languageCode](./auth-types.actioncodeurl.languagecode.md)
4+
5+
## ActionCodeURL.languageCode property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly languageCode: string | null;
11+
```

‎docs-exp/auth-types.actioncodeurl.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md)
4+
5+
## ActionCodeURL class
6+
7+
https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export abstract class ActionCodeURL
13+
```
14+
15+
## Properties
16+
17+
| Property | Modifiers | Type | Description |
18+
| --- | --- | --- | --- |
19+
| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | |
20+
| [code](./auth-types.actioncodeurl.code.md) | | string | |
21+
| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | |
22+
| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | |
23+
| [operation](./auth-types.actioncodeurl.operation.md) | | [Operation](./auth-types.operation.md) | |
24+
| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | |
25+
26+
## Methods
27+
28+
| Method | Modifiers | Description |
29+
| --- | --- | --- |
30+
| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | <code>static</code> | |
31+

‎docs-exp/auth-types.actioncodeurl.operation.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [operation](./auth-types.actioncodeurl.operation.md)
4+
5+
## ActionCodeURL.operation property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly operation: Operation;
11+
```

‎docs-exp/auth-types.actioncodeurl.parselink.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [parseLink](./auth-types.actioncodeurl.parselink.md)
4+
5+
## ActionCodeURL.parseLink() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
static parseLink(link: string): ActionCodeURL | null;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| link | string | |
18+
19+
<b>Returns:</b>
20+
21+
[ActionCodeURL](./auth-types.actioncodeurl.md) \| null
22+

‎docs-exp/auth-types.actioncodeurl.tenantid.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [tenantId](./auth-types.actioncodeurl.tenantid.md)
4+
5+
## ActionCodeURL.tenantId property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly tenantId: string | null;
11+
```

‎docs-exp/auth-types.additionaluserinfo.isnewuser.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [isNewUser](./auth-types.additionaluserinfo.isnewuser.md)
4+
5+
## AdditionalUserInfo.isNewUser property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly isNewUser: boolean;
11+
```

‎docs-exp/auth-types.additionaluserinfo.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md)
4+
5+
## AdditionalUserInfo interface
6+
7+
Additional user information.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface AdditionalUserInfo
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | |
20+
| [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null | |
21+
| [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | |
22+
| [username](./auth-types.additionaluserinfo.username.md) | string \| null | |
23+

‎docs-exp/auth-types.additionaluserinfo.profile.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [profile](./auth-types.additionaluserinfo.profile.md)
4+
5+
## AdditionalUserInfo.profile property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly profile: UserProfile | null;
11+
```

‎docs-exp/auth-types.additionaluserinfo.providerid.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [providerId](./auth-types.additionaluserinfo.providerid.md)
4+
5+
## AdditionalUserInfo.providerId property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly providerId: ProviderId | null;
11+
```

‎docs-exp/auth-types.additionaluserinfo.username.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [username](./auth-types.additionaluserinfo.username.md)
4+
5+
## AdditionalUserInfo.username property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly username?: string | null;
11+
```

‎docs-exp/auth-types.applicationverifier.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ApplicationVerifier](./auth-types.applicationverifier.md)
4+
5+
## ApplicationVerifier interface
6+
7+
https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface ApplicationVerifier
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [type](./auth-types.applicationverifier.type.md) | string | |
20+
21+
## Methods
22+
23+
| Method | Description |
24+
| --- | --- |
25+
| [verify()](./auth-types.applicationverifier.verify.md) | |
26+

‎docs-exp/auth-types.applicationverifier.type.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/auth-types](./auth-types.md) &gt; [ApplicationVerifier](./auth-types.applicationverifier.md) &gt; [type](./auth-types.applicationverifier.type.md)
4+
5+
## ApplicationVerifier.type property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly type: string;
11+
```

‎docs-exp/auth-types.applicationverifier.verify.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ApplicationVerifier](./auth-types.applicationverifier.md) &gt; [verify](./auth-types.applicationverifier.verify.md)
4+
5+
## ApplicationVerifier.verify() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
verify(): Promise<string>;
11+
```
12+
<b>Returns:</b>
13+
14+
Promise&lt;string&gt;
15+

0 commit comments

Comments
 (0)