docs-devsite/auth.recaptchaverifier.md
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 %}
An reCAPTCHA<!-- -->-based application verifier.
RecaptchaVerifier does not work in a Node.js environment.
<b>Signature:</b>
export declare class RecaptchaVerifier implements ApplicationVerifierInternal
<b>Implements:</b> ApplicationVerifierInternal
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(authExtern, containerOrId, parameters) | Constructs a new instance of the <code>RecaptchaVerifier</code> class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| type | (not declared) | The application verifier type. |
| Method | Modifiers | Description |
|---|---|---|
| clear() | Clears the reCAPTCHA widget from the page and destroys the instance. | |
| render() | Renders the reCAPTCHA widget on the page. | |
| verify() | Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. |
Constructs a new instance of the RecaptchaVerifier class
Check the reCAPTCHA docs for a comprehensive list. All parameters are accepted except for the sitekey. Firebase Auth backend provisions a reCAPTCHA for each project and will configure this upon rendering. For an invisible reCAPTCHA, a size key must have the value 'invisible'.
<b>Signature:</b>
constructor(authExtern: Auth, containerOrId: HTMLElement | string, parameters?: RecaptchaParameters);
| Parameter | Type | Description |
|---|---|---|
| authExtern | Auth | The corresponding Firebase Auth instance. |
| containerOrId | HTMLElement | string | The reCAPTCHA container parameter. |
| parameters | RecaptchaParameters | The optional reCAPTCHA parameters. |
The application verifier type.
For a reCAPTCHA verifier, this is 'recaptcha'.
<b>Signature:</b>
readonly type = "recaptcha";
Clears the reCAPTCHA widget from the page and destroys the instance.
<b>Signature:</b>
clear(): void;
<b>Returns:</b>
void
Renders the reCAPTCHA widget on the page.
<b>Signature:</b>
render(): Promise<number>;
<b>Returns:</b>
Promise<number>
A Promise that resolves with the reCAPTCHA widget ID.
Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token.
<b>Signature:</b>
verify(): Promise<string>;
<b>Returns:</b>
Promise<string>
A Promise for the reCAPTCHA token.