Skip to content

Commit

Permalink
Fixed readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
chvarkov committed Nov 1, 2020
1 parent e444798 commit b15b04f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ export class AppModule {

**Configuration options**

| Property | Type | Description |
|-------------------|------------------------------------------------------|-------------|
| `secretKey` | string | **Required.** Google recaptcha secret key |
| `response` | (request) => string | **Required.** Function that returns response (recaptcha token) by request |
| `skipIf` | boolean \| (request) => boolean \| Promise<boolean> | Optional. Function that returns true if you allow the request to skip the recaptcha verification. Useful for involing other check methods (e.g. custom privileged API key) or for development or testing |
| `useRecaptchaNet` | boolean | Optional. If your server has trouble connecting to https://www.google.com. You can use https://recaptcha.net instead, just set true |
| `agent` | https.Agent | Optional. If you need to use an agent |
| Property | Type | Description |
|-------------------|--------------------------------------------------------|-------------|
| `secretKey` | string | **Required.** Google recaptcha secret key |
| `response` | (request) => string | **Required.** Function that returns response (recaptcha token) by request |
| `skipIf` | boolean \| (request) => boolean \| Promise\<boolean\> | Optional. Function that returns true if you allow the request to skip the recaptcha verification. Useful for involing other check methods (e.g. custom privileged API key) or for development or testing |
| `useRecaptchaNet` | boolean | Optional. If your server has trouble connecting to https://www.google.com. You can use https://recaptcha.net instead, just set true |
| `agent` | https.Agent | Optional. If you need to use an agent |


If you want import configs from your [ConfigService](https://docs.nestjs.com/techniques/configuration#getting-started) via [custom getter function](https://docs.nestjs.com/techniques/configuration#custom-getter-functions) that will return `GoogleRecaptchaModuleOptions` object.
Expand Down

0 comments on commit b15b04f

Please sign in to comment.