Skip to content

Commit 09ccd0e

Browse files
committed
yarn docgen:all
1 parent db2b2d5 commit 09ccd0e

File tree

4 files changed

+59
-1
lines changed

4 files changed

+59
-1
lines changed

docs-devsite/_toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,8 @@ toc:
306306
path: /docs/reference/js/auth.samlauthprovider.md
307307
- title: TenantConfig
308308
path: /docs/reference/js/auth.tenantconfig.md
309+
- title: TokenResponse
310+
path: /docs/reference/js/auth.tokenresponse.md
309311
- title: TotpMultiFactorAssertion
310312
path: /docs/reference/js/auth.totpmultifactorassertion.md
311313
- title: TotpMultiFactorGenerator

docs-devsite/auth.auth.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ export interface Auth
3333
| [settings](./auth.auth.md#authsettings) | [AuthSettings](./auth.authsettings.md#authsettings_interface) | The [Auth](./auth.auth.md#auth_interface) instance's settings. |
3434
| [tenantConfig](./auth.auth.md#authtenantconfig) | [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) | The [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) used to initialize a Regional Auth. This is only present if regional auth is initialized and backend endpoint is used. |
3535
| [tenantId](./auth.auth.md#authtenantid) | string \| null | The [Auth](./auth.auth.md#auth_interface) instance's tenant ID. |
36+
| [tokenResponse](./auth.auth.md#authtokenresponse) | [TokenResponse](./auth.tokenresponse.md#tokenresponse_interface) \| null | The token response initialized via [exchangeToken()](./auth.md#exchangetoken_b6b1871) endpoint. |
3637

3738
## Methods
3839

@@ -156,6 +157,18 @@ const result = await signInWithEmailAndPassword(auth, email, password);
156157

157158
```
158159

160+
## Auth.tokenResponse
161+
162+
The token response initialized via [exchangeToken()](./auth.md#exchangetoken_b6b1871) endpoint.
163+
164+
This field is only supported for [Auth](./auth.auth.md#auth_interface) instance that have defined [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface)<!-- -->.
165+
166+
<b>Signature:</b>
167+
168+
```typescript
169+
readonly tokenResponse: TokenResponse | null;
170+
```
171+
159172
## Auth.authStateReady()
160173

161174
returns a promise that resolves immediately when the initial auth state is settled. When the promise resolves, the current user might be a valid user or `null` if the user signed out.

docs-devsite/auth.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ Firebase Authentication
139139
| [ReactNativeAsyncStorage](./auth.reactnativeasyncstorage.md#reactnativeasyncstorage_interface) | Interface for a supplied <code>AsyncStorage</code>. |
140140
| [RecaptchaParameters](./auth.recaptchaparameters.md#recaptchaparameters_interface) | Interface representing reCAPTCHA parameters.<!-- -->See the [reCAPTCHA docs](https://developers.google.com/recaptcha/docs/display#render_param) for the list of accepted parameters. All parameters are accepted except for <code>sitekey</code>: Firebase Auth provisions a reCAPTCHA for each project and will configure the site key upon rendering.<!-- -->For an invisible reCAPTCHA, set the <code>size</code> key to <code>invisible</code>. |
141141
| [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) | The tenant config that can be used to initialize a Regional [Auth](./auth.auth.md#auth_interface) instance. |
142+
| [TokenResponse](./auth.tokenresponse.md#tokenresponse_interface) | Interface for TokenRespone returned via [exchangeToken()](./auth.md#exchangetoken_b6b1871) endpoint. This is expected to be returned only if [Auth](./auth.auth.md#auth_interface) object initialized has defined [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface)<!-- -->. |
142143
| [TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface) | The class for asserting ownership of a TOTP second factor. Provided by [TotpMultiFactorGenerator.assertionForEnrollment()](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorassertionforenrollment) and [TotpMultiFactorGenerator.assertionForSignIn()](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorassertionforsignin)<!-- -->. |
143144
| [TotpMultiFactorInfo](./auth.totpmultifactorinfo.md#totpmultifactorinfo_interface) | The subclass of the [MultiFactorInfo](./auth.multifactorinfo.md#multifactorinfo_interface) interface for TOTP second factors. The <code>factorId</code> of this second factor is [FactorId](./auth.md#factorid)<!-- -->.TOTP. |
144145
| [User](./auth.user.md#user_interface) | A user account. |
@@ -410,7 +411,7 @@ Promise&lt;[UserCredential](./auth.usercredential.md#usercredential_interface)<!
410411

411412
Asynchronously exchanges an OIDC provider's Authorization code or Id Token for an OidcToken i.e. Outbound Access Token.
412413

413-
This method is imeplemented only for and requires [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) to be configured in the [Auth](./auth.auth.md#auth_interface) instance used.
414+
This method is implemented only for and requires [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) to be configured in the [Auth](./auth.auth.md#auth_interface) instance used.
414415

415416
Fails with an error if the token is invalid, expired, or not accepted by the Firebase Auth service.
416417

docs-devsite/auth.tokenresponse.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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+
# TokenResponse interface
13+
Interface for TokenRespone returned via [exchangeToken()](./auth.md#exchangetoken_b6b1871) endpoint. This is expected to be returned only if [Auth](./auth.auth.md#auth_interface) object initialized has defined [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface TokenResponse
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [expiresIn](./auth.tokenresponse.md#tokenresponseexpiresin) | string | |
26+
| [token](./auth.tokenresponse.md#tokenresponsetoken) | string | |
27+
28+
## TokenResponse.expiresIn
29+
30+
<b>Signature:</b>
31+
32+
```typescript
33+
readonly expiresIn: string;
34+
```
35+
36+
## TokenResponse.token
37+
38+
<b>Signature:</b>
39+
40+
```typescript
41+
readonly token: string;
42+
```

0 commit comments

Comments
 (0)