Skip to content

Commit 2d776b9

Browse files
committed
Addressing review comments
1 parent e2d7605 commit 2d776b9

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs-devsite/auth.dependencies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface Dependencies
2929
| [errorMap](./auth.dependencies.md#dependencieserrormap) | [AuthErrorMap](./auth.autherrormap.md#autherrormap_interface) | Which [AuthErrorMap](./auth.autherrormap.md#autherrormap_interface) to use. |
3030
| [persistence](./auth.dependencies.md#dependenciespersistence) | [Persistence](./auth.persistence.md#persistence_interface) \| [Persistence](./auth.persistence.md#persistence_interface)<!-- -->\[\] | Which [Persistence](./auth.persistence.md#persistence_interface) to use. If this is an array, the first <code>Persistence</code> that the device supports is used. The SDK searches for an existing account in order and, if one is found in a secondary <code>Persistence</code>, the account is moved to the primary <code>Persistence</code>.<!-- -->If no persistence is provided, the SDK falls back on [inMemoryPersistence](./auth.md#inmemorypersistence)<!-- -->. |
3131
| [popupRedirectResolver](./auth.dependencies.md#dependenciespopupredirectresolver) | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | The [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) to use. This value depends on the platform. Options are [browserPopupRedirectResolver](./auth.md#browserpopupredirectresolver) and [cordovaPopupRedirectResolver](./auth.md#cordovapopupredirectresolver)<!-- -->. This field is optional if neither [signInWithPopup()](./auth.md#signinwithpopup_770f816) or [signInWithRedirect()](./auth.md#signinwithredirect_770f816) are being used. |
32-
| [tenantConfig](./auth.dependencies.md#dependenciestenantconfig) | [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) | The [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) to use. This field is optional and required if Regional Auth Instance needs to be configured. The Auth instance depends on the endpoint. |
32+
| [tenantConfig](./auth.dependencies.md#dependenciestenantconfig) | [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) | The [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) to use. This dependency is only required if you want to use regional auth which works with endpoint. It should not be set otherwise. |
3333

3434
## Dependencies.errorMap
3535

@@ -65,7 +65,7 @@ popupRedirectResolver?: PopupRedirectResolver;
6565

6666
## Dependencies.tenantConfig
6767

68-
The [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) to use. This field is optional and required if Regional Auth Instance needs to be configured. The Auth instance depends on the endpoint.
68+
The [TenantConfig](./auth.tenantconfig.md#tenantconfig_interface) to use. This dependency is only required if you want to use regional auth which works with endpoint. It should not be set otherwise.
6969

7070
<b>Signature:</b>
7171

docs-devsite/auth.tenantconfig.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Which location to use.
3232
<b>Signature:</b>
3333

3434
```typescript
35-
location?: string;
35+
location: string;
3636
```
3737

3838
## TenantConfig.tenantId
@@ -42,5 +42,5 @@ The tenant Id being used.
4242
<b>Signature:</b>
4343

4444
```typescript
45-
tenantId?: string;
45+
tenantId: string;
4646
```

packages/auth/src/model/public_types.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1261,9 +1261,9 @@ export interface Dependencies {
12611261
*/
12621262
errorMap?: AuthErrorMap;
12631263
/**
1264-
* The {@link TenantConfig} to use. This field is optional and required
1265-
* if Regional Auth Instance needs to be configured. The Auth instance depends
1266-
* on the {@link DefaultConfig.REGIONAL_API_HOST} endpoint.
1264+
* The {@link TenantConfig} to use. This dependency is only required
1265+
* if you want to use regional auth which works with
1266+
* {@link DefaultConfig.REGIONAL_API_HOST} endpoint. It should not be set otherwise.
12671267
*/
12681268
tenantConfig?: TenantConfig;
12691269
}
@@ -1277,11 +1277,11 @@ export interface TenantConfig {
12771277
/**
12781278
* Which location to use.
12791279
*/
1280-
location?: string;
1280+
location: string;
12811281
/**
12821282
* The tenant Id being used.
12831283
*/
1284-
tenantId?: string;
1284+
tenantId: string;
12851285
}
12861286

12871287
/**

0 commit comments

Comments
 (0)