class-validator-extended
Version:
Additional validators for class-validator.
112 lines (93 loc) • 16.9 kB
Markdown
[](https://www.npmjs.com/package/class-validator-extended)
[](https://github.com/pigulla/class-validator-extended/issues)
[](https://libraries.io/npm/class-validator-extended)
[](https://app.codecov.io/gh/pigulla/class-validator-extended)
[](https://bundlephobia.com/package/class-validator-extended)
# class-validator-extended
> Additional validators for [class-validator](https://github.com/typestack/class-validator).
#### Safe and simple to use
- 🕵️♀️ [Thoroughly tested](https://app.codecov.io/gh/pigulla/class-validator-extended)
- 📝 [Well documented](https://pigulla.github.io/class-validator-extended/)
- ✨ No additional dependencies ([Day.js](https://day.js.org/) is supported but optional)
- 😊 Uses [Semantic Versioning](https://semver.org/) and keeps a [nice](https://keepachangelog.com/en/1.0.0/) [Changelog](https://github.com/pigulla/class-validator-extended/blob/main/CHANGELOG.md)
## Installation
Use your favorite package manager to install:
```bash
npm install class-validator-extended
```
For obvious reasons, [class-validator](https://github.com/typestack/class-validator) needs to be installed.
## Usage
Just use the decorators like any of the built-in ones:
```typescript
import { ArrayMinSize } from 'class-validator'
import { ArrayMonotonic } from 'class-validator-extended'
class Foo {
@ArrayMinSize(2)
@ArrayMonotonic()
values: [1, 13, 42]
}
```
If you don't have [Dayjs](https://day.js.org/) installed you need to use the `minimal` export:
```typescript
import { MaxBigInt } from 'class-validator-extended/dist/minimal'
```
Please note that Dayjs is an [optional dependency](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#optionaldependencies) and will by default be installed by npm and yarn. To avoid this use `npm install --omit optional` or `yarn install --ignore-optional`, respectively.
## Validation decorators
For detailed information please read the [API docs](https://pigulla.github.io/class-validator-extended/modules.html).
| Decorator | Description | API |
| :------------------------------------------- | :---------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------: |
| **Type** | | |
| `@IsBigInt(options?)` | Checks if the given value is a BigInt. | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsBigInt-1.html) |
| `@IsDayjs(options?)` | Checks if the given value is a valid Dayjs object. | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsDayjs-1.html) |
| `@IsDuration(options?)` | Checks if the given value is a valid Dayjs duration. | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsDuration-1.html) |
| `@IsNull(options?)` | Checks if the given value is `null`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsNull-1.html) |
| `@IsMap(options?)` | Checks if the given value is a Map. | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsMap-1.html) |
| `@IsSet(options?)` | Checks if the given value is a Set. | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsSet-1.html) |
| **Common** | | |
| `@Nullable(options?)` | Only validates the given value if it is not `null`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/Nullable-1.html) |
| `@Optional(options?)` | Only validates the given value if it is not `undefined`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/Optional-1.html) |
| **Array** | | |
| `@ArrayMonotonic(options?)` | Checks if the given value is an array sorted in either (strictly) ascending or (strictly) descending order. | [🔗](https://pigulla.github.io/class-validator-extended/functions/ArrayMonotonic-1.html) |
| `@ArraySize(size, options?)` | Checks if the given value is an array with exactly `size` elements. | [🔗](https://pigulla.github.io/class-validator-extended/functions/ArraySize-1.html) |
| **BigInt** | | |
| `@MaxBigInt(maximum, options?)` | Checks if the given value is a BigInt not greater than `maximum`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MaxBigInt-1.html) |
| `@MinBigInt(minimum, options?)` | Checks if the given value is a BigInt not less than `minimum`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MinBigInt-1.html) |
| `@NegativeBigInt(options?)` | Checks if the given value is a BigInt less than zero. | [🔗](https://pigulla.github.io/class-validator-extended/functions/NegativeBigInt-1.html) |
| `@PositiveBigInt(options?)` | Checks if the given value is a BigInt greater than zero. | [🔗](https://pigulla.github.io/class-validator-extended/functions/PositiveBigInt-1.html) |
| **Date** | | |
| `@FutureDate(options?)` | Checks if the given value is a Date object in the future. | [🔗](https://pigulla.github.io/class-validator-extended/functions/FutureDate-1.html) |
| `@PastDate(options?)` | Checks if the given value is a Date object in the past. | [🔗](https://pigulla.github.io/class-validator-extended/functions/PastDate-1.html) |
| **Dayjs** | | |
| `@FutureDayjs(options?)` | Checks if the given value is a valid Dayjs object in the future. | [🔗](https://pigulla.github.io/class-validator-extended/functions/FutureDayjs-1.html) |
| `@MaxDayjs(maximum, options?)` | Checks if the given value is a valid Dayjs object not later than `maximum`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MaxDayjs-1.html) |
| `@MaxDuration(minimum, options?)` | Checks if the given value is a valid Dayjs duration not longer than `maximum`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MaxDuration-1.html) |
| `@MinDayjs(minimum, options?)` | Checks if the given value is a valid Dayjs object not earlier than `minimum`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MinDayjs-1.html) |
| `@MinDuration(minimum, options?)` | Checks if the given value is a valid Dayjs duration not shorter than `minimum`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MinDuration-1.html) |
| `@PastDayjs(options?)` | Checks if the given value is a valid Dayjs object in the past. | [🔗](https://pigulla.github.io/class-validator-extended/functions/PastDayjs-1.html) |
| **Map** | | |
| `@MapContains(required, options?)` | Checks if the given value is a Map and contains all `required` values. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapContains-1.html) |
| `@MapContainsKeys(required, options?)` | Checks if the given value is a Map and contains all `required` keys. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapContainsKeys-1.html) |
| `@MapMaxSize(maximum, options?)` | Checks if the given value is a Map with no more than `maximum` entries. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapMaxSize-1.html) |
| `@MapMinSize(minimum, options?)` | Checks if the given value is a Map with no fewer than `minimum` entries. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapMinSize-1.html) |
| `@MapNotContains(forbidden, options?)` | Checks if the given value is a Map which does not contain any of the `forbidden` values. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapNotContains-1.html) |
| `@MapNotContainsKeys(forbidden, options?)` | Checks if the given value is a Map which does not contain any of the `forbidden` keys. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapNotContainsKeys-1.html) |
| `@MapNotEmpty(options?)` | Checks if the given value is a Map with at least one entry. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapNotEmpty-1.html) |
| `@MapSize(size, options?)` | Checks if the given value is a Map with exactly `size` entries. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapSize-1.html) |
| `@MapUnique(projection, options?)` | Checks if the given value is a Map without duplicates with regard to the given `projection`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapUnique-1.html) |
| `@MapUniqueKeys(projection, options?)` | Checks if the given value is a Map whose keys are all unique with regard to the given `projection`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/MapUniqueKeys-1.html) |
| **Number** | | |
| `@IsNetworkPort(options?)` | Checks if the given value is a valid port number. | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsNetworkPort-1.html) |
| **Set** | | |
| `@SetContains(required, options?)` | Checks if the given value is a Set and contains all required values. | [🔗](https://pigulla.github.io/class-validator-extended/functions/SetContains-1.html) |
| `@SetMaxSize(maximum, options?)` | Checks if the given value is a Set with no more than `maximum` values. | [🔗](https://pigulla.github.io/class-validator-extended/functions/SetMaxSize-1.html) |
| `@SetMinSize(minimum, options?)` | Checks if the given value is a Set with no fewer than `minimum` values. | [🔗](https://pigulla.github.io/class-validator-extended/functions/SetMinSize-1.html) |
| `@SetNotContains(forbidden, options?)` | Checks if the given value is a Set which does not contain any of the `forbidden` values. | [🔗](https://pigulla.github.io/class-validator-extended/functions/SetNotContains-1.html) |
| `@SetSize(size, options?)` | Checks if the given value is a Set with exactly `size` entries. | [🔗](https://pigulla.github.io/class-validator-extended/functions/SetSize-1.html) |
| `@SetNotEmpty(options?)` | Checks if the given value is a Set with at least one value. | [🔗](https://pigulla.github.io/class-validator-extended/functions/SetNotEmpty-1.html) |
| `@SetUnique(projection, options?)` | Checks if the given value is a Set without duplicate values with regard to the given `projection`. | [🔗](https://pigulla.github.io/class-validator-extended/functions/SetUnique-1.html) |
| **String** | | |
| `@IsAwsRegion(options?)` | Checks if the given value is an AWS region string. **deprecated** | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsAwsRegion-1.html) |
| `@IsAwsARN(options?)` | Checks if the given value is an AWS ARN string. **deprecated** | [🔗](https://pigulla.github.io/class-validator-extended/functions/IsAwsARN-1.html) |
| `@NotMatches(pattern, modifiers?, options?)` | Checks if the given value is an string that does not match the given regular expression. | [🔗](https://pigulla.github.io/class-validator-extended/functions/NotMatches-1.html) |