Skip to content

Commit

Permalink
doc gen output
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque committed May 22, 2024
1 parent 333bb0f commit 491e4ed
Show file tree
Hide file tree
Showing 63 changed files with 1,848 additions and 5,675 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,18 @@ export declare class ActionCodeURL

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiKey](./auth.actioncodeurl.md#actioncodeurlapikey) | | string | The API key of the email action link. |
| [code](./auth.actioncodeurl.md#actioncodeurlcode) | | string | The action code of the email action link. |
| [continueUrl](./auth.actioncodeurl.md#actioncodeurlcontinueurl) | | string \| null | The continue URL of the email action link. Null if not provided. |
| [languageCode](./auth.actioncodeurl.md#actioncodeurllanguagecode) | | string \| null | The language code of the email action link. Null if not provided. |
| [operation](./auth.actioncodeurl.md#actioncodeurloperation) | | string | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth.actioncodeinfo.md#actioncodeinfo_interface) |
| [tenantId](./auth.actioncodeurl.md#actioncodeurltenantid) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
| [apiKey](./auth-web-extension.actioncodeurl.md#actioncodeurlapikey) | | string | The API key of the email action link. |
| [code](./auth-web-extension.actioncodeurl.md#actioncodeurlcode) | | string | The action code of the email action link. |
| [continueUrl](./auth-web-extension.actioncodeurl.md#actioncodeurlcontinueurl) | | string \| null | The continue URL of the email action link. Null if not provided. |
| [languageCode](./auth-web-extension.actioncodeurl.md#actioncodeurllanguagecode) | | string \| null | The language code of the email action link. Null if not provided. |
| [operation](./auth-web-extension.actioncodeurl.md#actioncodeurloperation) | | string | The action performed by the email action link. It returns from one of the types from |
| [tenantId](./auth-web-extension.actioncodeurl.md#actioncodeurltenantid) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [parseLink(link)](./auth.actioncodeurl.md#actioncodeurlparselink) | <code>static</code> | Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null. |
| [parseLink(link)](./auth-web-extension.actioncodeurl.md#actioncodeurlparselink) | <code>static</code> | Parses the email action link string and returns an [ActionCodeURL](./auth-web-extension.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null. |

## ActionCodeURL.apiKey

Expand Down Expand Up @@ -79,7 +79,7 @@ readonly languageCode: string | null;

## ActionCodeURL.operation

The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth.actioncodeinfo.md#actioncodeinfo_interface)
The action performed by the email action link. It returns from one of the types from

<b>Signature:</b>

Expand All @@ -99,7 +99,7 @@ readonly tenantId: string | null;

## ActionCodeURL.parseLink()

Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null.
Parses the email action link string and returns an [ActionCodeURL](./auth-web-extension.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null.

<b>Signature:</b>

Expand All @@ -115,7 +115,7 @@ static parseLink(link: string): ActionCodeURL | null;

<b>Returns:</b>

[ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) \| null
[ActionCodeURL](./auth-web-extension.actioncodeurl.md#actioncodeurl_class) \| null

The [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) object, or null if the link is invalid.
The [ActionCodeURL](./auth-web-extension.actioncodeurl.md#actioncodeurl_class) object, or null if the link is invalid.

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# AuthCredential class
Interface that represents the credentials returned by an [AuthProvider](./auth.authprovider.md#authprovider_interface)<!-- -->.
Interface that represents the credentials returned by an .

Implementations specify the details about each auth provider's credential requirements.

Expand All @@ -26,14 +26,14 @@ export declare class AuthCredential

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [providerId](./auth.authcredential.md#authcredentialproviderid) | | string | The authentication provider ID for the credential. |
| [signInMethod](./auth.authcredential.md#authcredentialsigninmethod) | | string | The authentication sign in method for the credential. |
| [providerId](./auth-web-extension.authcredential.md#authcredentialproviderid) | | string | The authentication provider ID for the credential. |
| [signInMethod](./auth-web-extension.authcredential.md#authcredentialsigninmethod) | | string | The authentication sign in method for the credential. |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [toJSON()](./auth.authcredential.md#authcredentialtojson) | | Returns a JSON-serializable representation of this object. |
| [toJSON()](./auth-web-extension.authcredential.md#authcredentialtojson) | | Returns a JSON-serializable representation of this object. |

## AuthCredential.providerId

Expand All @@ -51,7 +51,7 @@ readonly providerId: string;

The authentication sign in method for the credential.

For example, [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_PASSWORD, or [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_LINK. This corresponds to the sign-in method identifier as returned in [fetchSignInMethodsForEmail()](./auth.md#fetchsigninmethodsforemail_efb3887)<!-- -->.
For example, .EMAIL\_PASSWORD, or .EMAIL\_LINK. This corresponds to the sign-in method identifier as returned in [fetchSignInMethodsForEmail()](./auth-web-extension.md#fetchsigninmethodsforemail_efb3887)<!-- -->.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# EmailAuthCredential class
Interface that represents the credentials returned by [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) for [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD
Interface that represents the credentials returned by [EmailAuthProvider](./auth-web-extension.emailauthprovider.md#emailauthprovider_class) for .PASSWORD

Covers both [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_PASSWORD and [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_LINK.
Covers both .EMAIL\_PASSWORD and .EMAIL\_LINK.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `EmailAuthCredential` class.

Expand All @@ -21,18 +21,18 @@ The constructor for this class is marked as internal. Third-party code should no
```typescript
export declare class EmailAuthCredential extends AuthCredential
```
<b>Extends:</b> [AuthCredential](./auth.authcredential.md#authcredential_class)
<b>Extends:</b> [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class)
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [fromJSON(json)](./auth.emailauthcredential.md#emailauthcredentialfromjson) | <code>static</code> | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth.authcredential.md#authcredential_class)<!-- -->. |
| [toJSON()](./auth.emailauthcredential.md#emailauthcredentialtojson) | | Returns a JSON-serializable representation of this object. |
| [fromJSON(json)](./auth-web-extension.emailauthcredential.md#emailauthcredentialfromjson) | <code>static</code> | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class)<!-- -->. |
| [toJSON()](./auth-web-extension.emailauthcredential.md#emailauthcredentialtojson) | | Returns a JSON-serializable representation of this object. |
## EmailAuthCredential.fromJSON()
Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth.authcredential.md#authcredential_class)<!-- -->.
Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class)<!-- -->.
<b>Signature:</b>
Expand All @@ -48,9 +48,9 @@ static fromJSON(json: object | string): EmailAuthCredential | null;
<b>Returns:</b>
[EmailAuthCredential](./auth.emailauthcredential.md#emailauthcredential_class) \| null
[EmailAuthCredential](./auth-web-extension.emailauthcredential.md#emailauthcredential_class) \| null
If the JSON input does not represent an [AuthCredential](./auth.authcredential.md#authcredential_class)<!-- -->, null is returned.
If the JSON input does not represent an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class)<!-- -->, null is returned.
## EmailAuthCredential.toJSON()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,34 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# EmailAuthProvider class
Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md#emailauthcredential_class)<!-- -->.
Provider for generating [EmailAuthCredential](./auth-web-extension.emailauthcredential.md#emailauthcredential_class)<!-- -->.

<b>Signature:</b>

```typescript
export declare class EmailAuthProvider implements AuthProvider
```
<b>Implements:</b> [AuthProvider](./auth.authprovider.md#authprovider_interface)
<b>Implements:</b> AuthProvider
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth.emailauthprovider.md#emailauthprovideremail_link_sign_in_method) | <code>static</code> | 'emailLink' | Always set to [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_LINK. |
| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth.emailauthprovider.md#emailauthprovideremail_password_sign_in_method) | <code>static</code> | 'password' | Always set to [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_PASSWORD. |
| [PROVIDER\_ID](./auth.emailauthprovider.md#emailauthproviderprovider_id) | <code>static</code> | 'password' | Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link. |
| [providerId](./auth.emailauthprovider.md#emailauthproviderproviderid) | | "password" | Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link. |
| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth-web-extension.emailauthprovider.md#emailauthprovideremail_link_sign_in_method) | <code>static</code> | 'emailLink' | Always set to .EMAIL\_LINK. |
| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth-web-extension.emailauthprovider.md#emailauthprovideremail_password_sign_in_method) | <code>static</code> | 'password' | Always set to .EMAIL\_PASSWORD. |
| [PROVIDER\_ID](./auth-web-extension.emailauthprovider.md#emailauthproviderprovider_id) | <code>static</code> | 'password' | Always set to .PASSWORD, even for email link. |
| [providerId](./auth-web-extension.emailauthprovider.md#emailauthproviderproviderid) | | "password" | Always set to .PASSWORD, even for email link. |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [credential(email, password)](./auth.emailauthprovider.md#emailauthprovidercredential) | <code>static</code> | Initialize an [AuthCredential](./auth.authcredential.md#authcredential_class) using an email and password. |
| [credentialWithLink(email, emailLink)](./auth.emailauthprovider.md#emailauthprovidercredentialwithlink) | <code>static</code> | Initialize an [AuthCredential](./auth.authcredential.md#authcredential_class) using an email and an email link after a sign in with email link operation. |
| [credential(email, password)](./auth-web-extension.emailauthprovider.md#emailauthprovidercredential) | <code>static</code> | Initialize an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class) using an email and password. |
| [credentialWithLink(email, emailLink)](./auth-web-extension.emailauthprovider.md#emailauthprovidercredentialwithlink) | <code>static</code> | Initialize an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class) using an email and an email link after a sign in with email link operation. |
## EmailAuthProvider.EMAIL\_LINK\_SIGN\_IN\_METHOD
Always set to [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_LINK.
Always set to .EMAIL\_LINK.
<b>Signature:</b>
Expand All @@ -47,7 +47,7 @@ static readonly EMAIL_LINK_SIGN_IN_METHOD: 'emailLink';
## EmailAuthProvider.EMAIL\_PASSWORD\_SIGN\_IN\_METHOD
Always set to [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_PASSWORD.
Always set to .EMAIL\_PASSWORD.
<b>Signature:</b>
Expand All @@ -57,7 +57,7 @@ static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: 'password';
## EmailAuthProvider.PROVIDER\_ID
Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link.
Always set to .PASSWORD, even for email link.
<b>Signature:</b>
Expand All @@ -67,7 +67,7 @@ static readonly PROVIDER_ID: 'password';
## EmailAuthProvider.providerId
Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link.
Always set to .PASSWORD, even for email link.
<b>Signature:</b>
Expand All @@ -77,7 +77,7 @@ readonly providerId: "password";
## EmailAuthProvider.credential()
Initialize an [AuthCredential](./auth.authcredential.md#authcredential_class) using an email and password.
Initialize an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class) using an email and password.
<b>Signature:</b>
Expand All @@ -94,7 +94,7 @@ static credential(email: string, password: string): EmailAuthCredential;
<b>Returns:</b>
[EmailAuthCredential](./auth.emailauthcredential.md#emailauthcredential_class)
[EmailAuthCredential](./auth-web-extension.emailauthcredential.md#emailauthcredential_class)
The auth provider credential.
Expand All @@ -117,7 +117,7 @@ const userCredential = await signInWithEmailAndPassword(auth, email, password);
## EmailAuthProvider.credentialWithLink()
Initialize an [AuthCredential](./auth.authcredential.md#authcredential_class) using an email and an email link after a sign in with email link operation.
Initialize an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class) using an email and an email link after a sign in with email link operation.
<b>Signature:</b>
Expand All @@ -134,7 +134,7 @@ static credentialWithLink(email: string, emailLink: string): EmailAuthCredential
<b>Returns:</b>
[EmailAuthCredential](./auth.emailauthcredential.md#emailauthcredential_class)
[EmailAuthCredential](./auth-web-extension.emailauthcredential.md#emailauthcredential_class)
- The auth provider credential.
Expand Down
Loading

0 comments on commit 491e4ed

Please sign in to comment.