Skip to content

Commit 6457326

Browse files
committed
docs: update IsNumberString docs
1 parent 62b993f commit 6457326

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -909,7 +909,7 @@ validator.isInstance(value, target); // Checks value is an instance of the targe
909909
| **String-type validation decorators** |
910910
| `@IsBooleanString()` | Checks if a string is a boolean (e.g. is "true" or "false"). |
911911
| `@IsDateString()` | Checks if a string is a complete representation of a date (e.g. "2017-06-07T14:34:08.700Z", "2017-06-07T14:34:08.700 or "2017-06-07T14:34:08+04:00"). |
912-
| `@IsNumberString()` | Checks if a string is a number. |
912+
| `@IsNumberString(options?: IsNumericOptions)` | Checks if a string is a number. |
913913
| **String validation decorators** |
914914
| `@Contains(seed: string)` | Checks if the string contains the seed. |
915915
| `@NotContains(seed: string)` | Checks if the string not contains the seed. |
@@ -948,7 +948,7 @@ validator.isInstance(value, target); // Checks value is an instance of the targe
948948
| `@IsPhoneNumber(region: string)` | Checks if the string is a valid phone number. "region" accepts 2 characters uppercase country code (e.g. DE, US, CH).If users must enter the intl. prefix (e.g. +41), then you may pass "ZZ" or null as region. See [google-libphonenumber, metadata.js:countryCodeToRegionCodeMap on github](https://github.com/ruimarinho/google-libphonenumber/blob/1e46138878cff479aafe2ce62175c6c49cb58720/src/metadata.js#L33) |
949949
| `@IsMongoId()` | Checks if the string is a valid hex-encoded representation of a MongoDB ObjectId. |
950950
| `@IsMultibyte()` | Checks if the string contains one or more multibyte chars. |
951-
| `@IsNumberString()` | Checks if the string is numeric. |
951+
| `@IsNumberString(options?: IsNumericOptions)` | Checks if the string is numeric. |
952952
| `@IsSurrogatePair()` | Checks if the string contains any surrogate pairs chars. |
953953
| `@IsUrl(options?: IsURLOptions)` | Checks if the string is an url. |
954954
| `@IsUUID(version?: "3"\|"4"\|"5"\|"all")` | Checks if the string is a UUID (version 3, 4, 5 or all ). |

0 commit comments

Comments
 (0)