Skip to content

Commit

Permalink
Merge pull request #17 from chvarkov/develop
Browse files Browse the repository at this point in the history
Updated readme.
  • Loading branch information
chvarkov authored Nov 1, 2020
2 parents 822d9cb + b15b04f commit 8e99ee3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ export class AppModule {

| 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 |
| `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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nestlab/google-recaptcha",
"version": "1.1.6",
"version": "1.1.7",
"description": "Google recaptcha module for NestJS.",
"keywords": [
"nest",
Expand Down

0 comments on commit 8e99ee3

Please sign in to comment.