Skip to content

Commit 491e4ed

Browse files
committed
doc gen output
1 parent 333bb0f commit 491e4ed

File tree

63 files changed

+1848
-5675
lines changed

Some content is hidden

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

63 files changed

+1848
-5675
lines changed

docs-devsite/auth.actioncodeurl.md renamed to docs-devsite/auth-web-extension.actioncodeurl.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ export declare class ActionCodeURL
2424

2525
| Property | Modifiers | Type | Description |
2626
| --- | --- | --- | --- |
27-
| [apiKey](./auth.actioncodeurl.md#actioncodeurlapikey) | | string | The API key of the email action link. |
28-
| [code](./auth.actioncodeurl.md#actioncodeurlcode) | | string | The action code of the email action link. |
29-
| [continueUrl](./auth.actioncodeurl.md#actioncodeurlcontinueurl) | | string \| null | The continue URL of the email action link. Null if not provided. |
30-
| [languageCode](./auth.actioncodeurl.md#actioncodeurllanguagecode) | | string \| null | The language code of the email action link. Null if not provided. |
31-
| [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) |
32-
| [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. |
27+
| [apiKey](./auth-web-extension.actioncodeurl.md#actioncodeurlapikey) | | string | The API key of the email action link. |
28+
| [code](./auth-web-extension.actioncodeurl.md#actioncodeurlcode) | | string | The action code of the email action link. |
29+
| [continueUrl](./auth-web-extension.actioncodeurl.md#actioncodeurlcontinueurl) | | string \| null | The continue URL of the email action link. Null if not provided. |
30+
| [languageCode](./auth-web-extension.actioncodeurl.md#actioncodeurllanguagecode) | | string \| null | The language code of the email action link. Null if not provided. |
31+
| [operation](./auth-web-extension.actioncodeurl.md#actioncodeurloperation) | | string | The action performed by the email action link. It returns from one of the types from |
32+
| [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. |
3333

3434
## Methods
3535

3636
| Method | Modifiers | Description |
3737
| --- | --- | --- |
38-
| [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. |
38+
| [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. |
3939

4040
## ActionCodeURL.apiKey
4141

@@ -79,7 +79,7 @@ readonly languageCode: string | null;
7979

8080
## ActionCodeURL.operation
8181

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

8484
<b>Signature:</b>
8585

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

100100
## ActionCodeURL.parseLink()
101101

102-
Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null.
102+
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.
103103

104104
<b>Signature:</b>
105105

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

116116
<b>Returns:</b>
117117

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

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

docs-devsite/auth.authcredential.md renamed to docs-devsite/auth-web-extension.authcredential.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

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

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

@@ -26,14 +26,14 @@ export declare class AuthCredential
2626

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

3232
## Methods
3333

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

3838
## AuthCredential.providerId
3939

@@ -51,7 +51,7 @@ readonly providerId: string;
5151

5252
The authentication sign in method for the credential.
5353

54-
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)<!-- -->.
54+
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)<!-- -->.
5555

5656
<b>Signature:</b>
5757

docs-devsite/auth.emailauthcredential.md renamed to docs-devsite/auth-web-extension.emailauthcredential.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

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

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

1717
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.
1818

@@ -21,18 +21,18 @@ The constructor for this class is marked as internal. Third-party code should no
2121
```typescript
2222
export declare class EmailAuthCredential extends AuthCredential
2323
```
24-
<b>Extends:</b> [AuthCredential](./auth.authcredential.md#authcredential_class)
24+
<b>Extends:</b> [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class)
2525
2626
## Methods
2727
2828
| Method | Modifiers | Description |
2929
| --- | --- | --- |
30-
| [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)<!-- -->. |
31-
| [toJSON()](./auth.emailauthcredential.md#emailauthcredentialtojson) | | Returns a JSON-serializable representation of this object. |
30+
| [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)<!-- -->. |
31+
| [toJSON()](./auth-web-extension.emailauthcredential.md#emailauthcredentialtojson) | | Returns a JSON-serializable representation of this object. |
3232
3333
## EmailAuthCredential.fromJSON()
3434
35-
Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth.authcredential.md#authcredential_class)<!-- -->.
35+
Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class)<!-- -->.
3636
3737
<b>Signature:</b>
3838
@@ -48,9 +48,9 @@ static fromJSON(json: object | string): EmailAuthCredential | null;
4848
4949
<b>Returns:</b>
5050
51-
[EmailAuthCredential](./auth.emailauthcredential.md#emailauthcredential_class) \| null
51+
[EmailAuthCredential](./auth-web-extension.emailauthcredential.md#emailauthcredential_class) \| null
5252
53-
If the JSON input does not represent an [AuthCredential](./auth.authcredential.md#authcredential_class)<!-- -->, null is returned.
53+
If the JSON input does not represent an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class)<!-- -->, null is returned.
5454
5555
## EmailAuthCredential.toJSON()
5656

docs-devsite/auth.emailauthprovider.md renamed to docs-devsite/auth-web-extension.emailauthprovider.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,34 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

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

1515
<b>Signature:</b>
1616

1717
```typescript
1818
export declare class EmailAuthProvider implements AuthProvider
1919
```
20-
<b>Implements:</b> [AuthProvider](./auth.authprovider.md#authprovider_interface)
20+
<b>Implements:</b> AuthProvider
2121
2222
## Properties
2323
2424
| Property | Modifiers | Type | Description |
2525
| --- | --- | --- | --- |
26-
| [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. |
27-
| [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. |
28-
| [PROVIDER\_ID](./auth.emailauthprovider.md#emailauthproviderprovider_id) | <code>static</code> | 'password' | Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link. |
29-
| [providerId](./auth.emailauthprovider.md#emailauthproviderproviderid) | | "password" | Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link. |
26+
| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth-web-extension.emailauthprovider.md#emailauthprovideremail_link_sign_in_method) | <code>static</code> | 'emailLink' | Always set to .EMAIL\_LINK. |
27+
| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth-web-extension.emailauthprovider.md#emailauthprovideremail_password_sign_in_method) | <code>static</code> | 'password' | Always set to .EMAIL\_PASSWORD. |
28+
| [PROVIDER\_ID](./auth-web-extension.emailauthprovider.md#emailauthproviderprovider_id) | <code>static</code> | 'password' | Always set to .PASSWORD, even for email link. |
29+
| [providerId](./auth-web-extension.emailauthprovider.md#emailauthproviderproviderid) | | "password" | Always set to .PASSWORD, even for email link. |
3030
3131
## Methods
3232
3333
| Method | Modifiers | Description |
3434
| --- | --- | --- |
35-
| [credential(email, password)](./auth.emailauthprovider.md#emailauthprovidercredential) | <code>static</code> | Initialize an [AuthCredential](./auth.authcredential.md#authcredential_class) using an email and password. |
36-
| [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. |
35+
| [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. |
36+
| [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. |
3737
3838
## EmailAuthProvider.EMAIL\_LINK\_SIGN\_IN\_METHOD
3939
40-
Always set to [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_LINK.
40+
Always set to .EMAIL\_LINK.
4141
4242
<b>Signature:</b>
4343
@@ -47,7 +47,7 @@ static readonly EMAIL_LINK_SIGN_IN_METHOD: 'emailLink';
4747
4848
## EmailAuthProvider.EMAIL\_PASSWORD\_SIGN\_IN\_METHOD
4949
50-
Always set to [SignInMethod](./auth.md#signinmethod)<!-- -->.EMAIL\_PASSWORD.
50+
Always set to .EMAIL\_PASSWORD.
5151
5252
<b>Signature:</b>
5353
@@ -57,7 +57,7 @@ static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: 'password';
5757
5858
## EmailAuthProvider.PROVIDER\_ID
5959
60-
Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link.
60+
Always set to .PASSWORD, even for email link.
6161
6262
<b>Signature:</b>
6363
@@ -67,7 +67,7 @@ static readonly PROVIDER_ID: 'password';
6767
6868
## EmailAuthProvider.providerId
6969
70-
Always set to [ProviderId](./auth.md#providerid)<!-- -->.PASSWORD, even for email link.
70+
Always set to .PASSWORD, even for email link.
7171
7272
<b>Signature:</b>
7373
@@ -77,7 +77,7 @@ readonly providerId: "password";
7777
7878
## EmailAuthProvider.credential()
7979
80-
Initialize an [AuthCredential](./auth.authcredential.md#authcredential_class) using an email and password.
80+
Initialize an [AuthCredential](./auth-web-extension.authcredential.md#authcredential_class) using an email and password.
8181
8282
<b>Signature:</b>
8383
@@ -94,7 +94,7 @@ static credential(email: string, password: string): EmailAuthCredential;
9494
9595
<b>Returns:</b>
9696
97-
[EmailAuthCredential](./auth.emailauthcredential.md#emailauthcredential_class)
97+
[EmailAuthCredential](./auth-web-extension.emailauthcredential.md#emailauthcredential_class)
9898
9999
The auth provider credential.
100100
@@ -117,7 +117,7 @@ const userCredential = await signInWithEmailAndPassword(auth, email, password);
117117
118118
## EmailAuthProvider.credentialWithLink()
119119
120-
Initialize an [AuthCredential](./auth.authcredential.md#authcredential_class) using an email and an email link after a sign in with email link operation.
120+
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.
121121
122122
<b>Signature:</b>
123123
@@ -134,7 +134,7 @@ static credentialWithLink(email: string, emailLink: string): EmailAuthCredential
134134
135135
<b>Returns:</b>
136136
137-
[EmailAuthCredential](./auth.emailauthcredential.md#emailauthcredential_class)
137+
[EmailAuthCredential](./auth-web-extension.emailauthcredential.md#emailauthcredential_class)
138138
139139
- The auth provider credential.
140140

0 commit comments

Comments
 (0)