diff --git a/README.md b/README.md index 886712dd7..89ae4c358 100644 --- a/README.md +++ b/README.md @@ -900,7 +900,8 @@ isBoolean(value); | `@IsISSN(options?: IsISSNOptions)` | Checks if the string is a ISSN. | | `@IsISRC()` | Checks if the string is a [ISRC](https://en.wikipedia.org/wiki/International_Standard_Recording_Code). | | `@IsRFC3339()` | Checks if the string is a valid [RFC 3339](https://tools.ietf.org/html/rfc3339) date. | -| `@IsStrongPassword(options?: IsStrongPasswordOptions)` | Checks if the string is a strong password. | +| `@IsStrongPassword(options?: IsStrongPasswordOptions)` | Check if the string can be considered a strong password or not. Allows for custom requirements or scoring rules. If returnScore is true, then the function returns an integer score for the password rather than a boolean. Default options: `{ minLength: 8, minLowercase: 1, minUppercase: 1, minNumbers: 1, minSymbols: 1, returnScore: false, pointsPerUnique: 1, pointsPerRepeat: 0.5, pointsForContainingLower: 10, pointsForContainingUpper: 10, pointsForContainingNumber: 10, pointsForContainingSymbol: 10 }` + | | **Array validation decorators** | | | `@ArrayContains(values: any[])` | Checks if array contains all values from the given array of values. | | `@ArrayNotContains(values: any[])` | Checks if array does not contain any of the given values. |