Skip to content

Reference docs for Auth next #3883

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 2 commits into from
Oct 3, 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
451 changes: 451 additions & 0 deletions common/api-review/auth-exp.api.md

Large diffs are not rendered by default.

557 changes: 557 additions & 0 deletions common/api-review/auth-types-exp.api.md

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions docs-exp/auth-types.actioncodeinfo.data.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/auth-types](./auth-types.md) &gt; [ActionCodeInfo](./auth-types.actioncodeinfo.md) &gt; [data](./auth-types.actioncodeinfo.data.md)

## ActionCodeInfo.data property

<b>Signature:</b>

```typescript
data: {
email?: string | null;
multiFactorInfo?: MultiFactorInfo | null;
previousEmail?: string | null;
};
```
21 changes: 21 additions & 0 deletions docs-exp/auth-types.actioncodeinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## ActionCodeInfo interface

https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo

<b>Signature:</b>

```typescript
export interface ActionCodeInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | |
| [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | |

11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodeinfo.operation.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/auth-types](./auth-types.md) &gt; [ActionCodeInfo](./auth-types.actioncodeinfo.md) &gt; [operation](./auth-types.actioncodeinfo.operation.md)

## ActionCodeInfo.operation property

<b>Signature:</b>

```typescript
operation: Operation;
```
15 changes: 15 additions & 0 deletions docs-exp/auth-types.actioncodesettings.android.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [android](./auth-types.actioncodesettings.android.md)

## ActionCodeSettings.android property

<b>Signature:</b>

```typescript
android?: {
installApp?: boolean;
minimumVersion?: string;
packageName: string;
};
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md)

## ActionCodeSettings.dynamicLinkDomain property

<b>Signature:</b>

```typescript
dynamicLinkDomain?: string;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodesettings.handlecodeinapp.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md)

## ActionCodeSettings.handleCodeInApp property

<b>Signature:</b>

```typescript
handleCodeInApp?: boolean;
```
13 changes: 13 additions & 0 deletions docs-exp/auth-types.actioncodesettings.ios.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [iOS](./auth-types.actioncodesettings.ios.md)

## ActionCodeSettings.iOS property

<b>Signature:</b>

```typescript
iOS?: {
bundleId: string;
};
```
24 changes: 24 additions & 0 deletions docs-exp/auth-types.actioncodesettings.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md)

## ActionCodeSettings interface

https://firebase.google.com/docs/reference/js/firebase.auth\#actioncodesettings

<b>Signature:</b>

```typescript
export interface ActionCodeSettings
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | |
| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | |
| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | |
| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | |
| [url](./auth-types.actioncodesettings.url.md) | string | |

11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodesettings.url.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/auth-types](./auth-types.md) &gt; [ActionCodeSettings](./auth-types.actioncodesettings.md) &gt; [url](./auth-types.actioncodesettings.url.md)

## ActionCodeSettings.url property

<b>Signature:</b>

```typescript
url: string;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodeurl.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [apiKey](./auth-types.actioncodeurl.apikey.md)

## ActionCodeURL.apiKey property

<b>Signature:</b>

```typescript
readonly apiKey: string;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodeurl.code.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [code](./auth-types.actioncodeurl.code.md)

## ActionCodeURL.code property

<b>Signature:</b>

```typescript
readonly code: string;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodeurl.continueurl.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [continueUrl](./auth-types.actioncodeurl.continueurl.md)

## ActionCodeURL.continueUrl property

<b>Signature:</b>

```typescript
readonly continueUrl: string | null;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodeurl.languagecode.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [languageCode](./auth-types.actioncodeurl.languagecode.md)

## ActionCodeURL.languageCode property

<b>Signature:</b>

```typescript
readonly languageCode: string | null;
```
31 changes: 31 additions & 0 deletions docs-exp/auth-types.actioncodeurl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## ActionCodeURL class

https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL

<b>Signature:</b>

```typescript
export abstract class ActionCodeURL
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | |
| [code](./auth-types.actioncodeurl.code.md) | | string | |
| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | |
| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | |
| [operation](./auth-types.actioncodeurl.operation.md) | | [Operation](./auth-types.operation.md) | |
| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | <code>static</code> | |

11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodeurl.operation.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [operation](./auth-types.actioncodeurl.operation.md)

## ActionCodeURL.operation property

<b>Signature:</b>

```typescript
readonly operation: Operation;
```
22 changes: 22 additions & 0 deletions docs-exp/auth-types.actioncodeurl.parselink.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [parseLink](./auth-types.actioncodeurl.parselink.md)

## ActionCodeURL.parseLink() method

<b>Signature:</b>

```typescript
static parseLink(link: string): ActionCodeURL | null;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| link | string | |

<b>Returns:</b>

[ActionCodeURL](./auth-types.actioncodeurl.md) \| null

11 changes: 11 additions & 0 deletions docs-exp/auth-types.actioncodeurl.tenantid.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/auth-types](./auth-types.md) &gt; [ActionCodeURL](./auth-types.actioncodeurl.md) &gt; [tenantId](./auth-types.actioncodeurl.tenantid.md)

## ActionCodeURL.tenantId property

<b>Signature:</b>

```typescript
readonly tenantId: string | null;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.additionaluserinfo.isnewuser.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [isNewUser](./auth-types.additionaluserinfo.isnewuser.md)

## AdditionalUserInfo.isNewUser property

<b>Signature:</b>

```typescript
readonly isNewUser: boolean;
```
23 changes: 23 additions & 0 deletions docs-exp/auth-types.additionaluserinfo.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md)

## AdditionalUserInfo interface

Additional user information.

<b>Signature:</b>

```typescript
export interface AdditionalUserInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | |
| [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null | |
| [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | |
| [username](./auth-types.additionaluserinfo.username.md) | string \| null | |

11 changes: 11 additions & 0 deletions docs-exp/auth-types.additionaluserinfo.profile.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [profile](./auth-types.additionaluserinfo.profile.md)

## AdditionalUserInfo.profile property

<b>Signature:</b>

```typescript
readonly profile: UserProfile | null;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.additionaluserinfo.providerid.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [providerId](./auth-types.additionaluserinfo.providerid.md)

## AdditionalUserInfo.providerId property

<b>Signature:</b>

```typescript
readonly providerId: ProviderId | null;
```
11 changes: 11 additions & 0 deletions docs-exp/auth-types.additionaluserinfo.username.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/auth-types](./auth-types.md) &gt; [AdditionalUserInfo](./auth-types.additionaluserinfo.md) &gt; [username](./auth-types.additionaluserinfo.username.md)

## AdditionalUserInfo.username property

<b>Signature:</b>

```typescript
readonly username?: string | null;
```
26 changes: 26 additions & 0 deletions docs-exp/auth-types.applicationverifier.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/auth-types](./auth-types.md) &gt; [ApplicationVerifier](./auth-types.applicationverifier.md)

## ApplicationVerifier interface

https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier

<b>Signature:</b>

```typescript
export interface ApplicationVerifier
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [type](./auth-types.applicationverifier.type.md) | string | |

## Methods

| Method | Description |
| --- | --- |
| [verify()](./auth-types.applicationverifier.verify.md) | |

11 changes: 11 additions & 0 deletions docs-exp/auth-types.applicationverifier.type.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/auth-types](./auth-types.md) &gt; [ApplicationVerifier](./auth-types.applicationverifier.md) &gt; [type](./auth-types.applicationverifier.type.md)

## ApplicationVerifier.type property

<b>Signature:</b>

```typescript
readonly type: string;
```
15 changes: 15 additions & 0 deletions docs-exp/auth-types.applicationverifier.verify.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/auth-types](./auth-types.md) &gt; [ApplicationVerifier](./auth-types.applicationverifier.md) &gt; [verify](./auth-types.applicationverifier.verify.md)

## ApplicationVerifier.verify() method

<b>Signature:</b>

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

Promise&lt;string&gt;

Loading