mirror of
https://github.com/hanzoai/firebase-js-sdk.git
synced 2026-09-24 16:59:10 +00:00
42 lines
2.1 KiB
Markdown
42 lines
2.1 KiB
Markdown
Project: /docs/reference/js/_project.yaml
|
|
Book: /docs/reference/_book.yaml
|
|
page_type: reference
|
|
|
|
{% comment %}
|
|
DO NOT EDIT THIS FILE!
|
|
This is generated by the JS SDK team, and any local changes will be
|
|
overwritten. Changes should be made in the source code at
|
|
https://github.com/firebase/firebase-js-sdk
|
|
{% endcomment %}
|
|
|
|
# AuthSettings interface
|
|
Interface representing an [Auth](./auth.auth.md#auth_interface) instance's settings.
|
|
|
|
Currently used for enabling/disabling app verification for phone Auth testing.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export interface AuthSettings
|
|
```
|
|
|
|
## Properties
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [appVerificationDisabledForTesting](./auth.authsettings.md#authsettingsappverificationdisabledfortesting) | boolean | When set, this property disables app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests.<!-- -->In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console.<!-- -->The default value is false (app verification is enabled). |
|
|
|
|
## AuthSettings.appVerificationDisabledForTesting
|
|
|
|
When set, this property disables app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests.
|
|
|
|
In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console.
|
|
|
|
The default value is false (app verification is enabled).
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
appVerificationDisabledForTesting: boolean;
|
|
```
|