Skip to content

Commit fee85c1

Browse files
committed
Reorder recaptchaVerifier params so auth is the first param
1 parent 1dc970d commit fee85c1

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs-devsite/auth.recaptchaverifier.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export declare class RecaptchaVerifier implements ApplicationVerifierInternal
2323
2424
| Constructor | Modifiers | Description |
2525
| --- | --- | --- |
26-
| [(constructor)(containerOrId, parameters, authExtern)](./auth.recaptchaverifier.md#recaptchaverifierconstructor) | | Constructs a new instance of the <code>RecaptchaVerifier</code> class |
26+
| [(constructor)(authExtern, containerOrId, parameters)](./auth.recaptchaverifier.md#recaptchaverifierconstructor) | | Constructs a new instance of the <code>RecaptchaVerifier</code> class |
2727
2828
## Properties
2929
@@ -48,16 +48,16 @@ Check the reCAPTCHA docs for a comprehensive list. All parameters are accepted e
4848
<b>Signature:</b>
4949
5050
```typescript
51-
constructor(containerOrId: HTMLElement | string, parameters: RecaptchaParameters, authExtern: Auth);
51+
constructor(authExtern: Auth, containerOrId: HTMLElement | string, parameters?: RecaptchaParameters);
5252
```
5353
5454
### Parameters
5555
5656
| Parameter | Type | Description |
5757
| --- | --- | --- |
58+
| authExtern | [Auth](./auth.auth.md#auth_interface) | The corresponding Firebase [Auth](./auth.auth.md#auth_interface) instance. |
5859
| containerOrId | HTMLElement \| string | The reCAPTCHA container parameter. |
5960
| parameters | [RecaptchaParameters](./auth.recaptchaparameters.md#recaptchaparameters_interface) | The optional reCAPTCHA parameters. |
60-
| authExtern | [Auth](./auth.auth.md#auth_interface) | The corresponding Firebase [Auth](./auth.auth.md#auth_interface) instance. |
6161
6262
## RecaptchaVerifier.type
6363

packages/auth/src/platform_browser/recaptcha/recaptcha_verifier.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,6 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
6767
private recaptcha: Recaptcha | null = null;
6868

6969
/**
70-
* @remarks
71-
* Check the reCAPTCHA docs for a comprehensive list. All parameters are accepted except for
72-
* the sitekey. Firebase Auth backend provisions a reCAPTCHA for each project and will
73-
* configure this upon rendering. For an invisible reCAPTCHA, a size key must have the value
74-
* 'invisible'.
75-
*
7670
* @param authExtern - The corresponding Firebase {@link Auth} instance.
7771
*
7872
* @param containerOrId - The reCAPTCHA container parameter.
@@ -84,6 +78,12 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
8478
* initialization.
8579
*
8680
* @param parameters - The optional reCAPTCHA parameters.
81+
*
82+
* @remarks
83+
* Check the reCAPTCHA docs for a comprehensive list. All parameters are accepted except for
84+
* the sitekey. Firebase Auth backend provisions a reCAPTCHA for each project and will
85+
* configure this upon rendering. For an invisible reCAPTCHA, a size key must have the value
86+
* 'invisible'.
8787
*/
8888
constructor(
8989
authExtern: Auth,

0 commit comments

Comments
 (0)