Skip to content

Commit 8646c65

Browse files
style: format code with prettier
1 parent b4a2ac4 commit 8646c65

File tree

169 files changed

+10443
-10537
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

169 files changed

+10443
-10537
lines changed

CHANGELOG.md

+121-146
Large diffs are not rendered by default.

README.md

+518-521
Large diffs are not rendered by default.

docs/README.md

+36-36
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
# Table of Contents
22

3-
* [Read Me](../README.md)
4-
* Getting Started
5-
* [Installation](introduction/installation.md)
6-
* [Usage with Typescript](introduction/usage-with-typescript.md)
7-
* [Usage with Javascript](introduction/usage-with-javascript.md)
8-
* [Dependency Injection](introduction/usage-with-di.md)
9-
* [Core Principes](introduction/core-principes.md)
10-
* [Basic Usage](basics/README.md)
11-
* [Validating objects](basics/validating-objects.md)
12-
* [Validating arrays](basics/validating-arrays.md)
13-
* [Validating nested objects](basics/validating-nested-objects.md)
14-
* [Advanced Usage](advanced/README.md)
15-
* [Conditional Validation](advanced/conditional-validation.md)
16-
* [Validation Groups](advanced/validation-groups.md)
17-
* [Inheritance](advanced/inheritance.md)
18-
* [Custom Validation Decorators](advanced/validations-decoratos.md)
19-
* [Custom Validation Classes](advanced/validation-classes.md)
20-
* [Decorators Reference](reference/decoratos.md)
21-
* [Common Decorators](reference/common-decoratos.md)
22-
* [Number Decorators](reference/number-decoratos.md)
23-
* [String Decorators](reference/string-decoratos.md)
24-
* [Date Decorators](reference/date-decoratos.md)
25-
* [Array Decorators](reference/array-decoratos.md)
26-
* [Recipes](recipes/README.md)
27-
* [Simple Validations](https://stackblitz.com/edit/class-transformer-simple-validations)
28-
* [Nested Objects](https://stackblitz.com/edit/class-transformer-nested-objects)
29-
* [Using Groups](https://stackblitz.com/edit/class-transformer-using-groups)
30-
* [Custom Validators](https://stackblitz.com/edit/class-transformer-custom-validator)
31-
* [Custom Decorators](https://stackblitz.com/edit/class-transformer-custom-decorators)
32-
* [Using Schemas](https://stackblitz.com/edit/class-transformer-schemas)
33-
* [Inheritance](https://stackblitz.com/edit/class-transformer-inheritance)
34-
* [API Reference](api/README.md)
35-
* [validate](api/validate.md)
36-
* [ValidatorOptions ](api/ValidatorOptions.md)
37-
* [ValidationError ](api/ValidationError.md)
38-
* [Change Log](../CHANGELOG.md)
3+
- [Read Me](../README.md)
4+
- Getting Started
5+
- [Installation](introduction/installation.md)
6+
- [Usage with Typescript](introduction/usage-with-typescript.md)
7+
- [Usage with Javascript](introduction/usage-with-javascript.md)
8+
- [Dependency Injection](introduction/usage-with-di.md)
9+
- [Core Principes](introduction/core-principes.md)
10+
- [Basic Usage](basics/README.md)
11+
- [Validating objects](basics/validating-objects.md)
12+
- [Validating arrays](basics/validating-arrays.md)
13+
- [Validating nested objects](basics/validating-nested-objects.md)
14+
- [Advanced Usage](advanced/README.md)
15+
- [Conditional Validation](advanced/conditional-validation.md)
16+
- [Validation Groups](advanced/validation-groups.md)
17+
- [Inheritance](advanced/inheritance.md)
18+
- [Custom Validation Decorators](advanced/validations-decoratos.md)
19+
- [Custom Validation Classes](advanced/validation-classes.md)
20+
- [Decorators Reference](reference/decoratos.md)
21+
- [Common Decorators](reference/common-decoratos.md)
22+
- [Number Decorators](reference/number-decoratos.md)
23+
- [String Decorators](reference/string-decoratos.md)
24+
- [Date Decorators](reference/date-decoratos.md)
25+
- [Array Decorators](reference/array-decoratos.md)
26+
- [Recipes](recipes/README.md)
27+
- [Simple Validations](https://stackblitz.com/edit/class-transformer-simple-validations)
28+
- [Nested Objects](https://stackblitz.com/edit/class-transformer-nested-objects)
29+
- [Using Groups](https://stackblitz.com/edit/class-transformer-using-groups)
30+
- [Custom Validators](https://stackblitz.com/edit/class-transformer-custom-validator)
31+
- [Custom Decorators](https://stackblitz.com/edit/class-transformer-custom-decorators)
32+
- [Using Schemas](https://stackblitz.com/edit/class-transformer-schemas)
33+
- [Inheritance](https://stackblitz.com/edit/class-transformer-inheritance)
34+
- [API Reference](api/README.md)
35+
- [validate](api/validate.md)
36+
- [ValidatorOptions ](api/ValidatorOptions.md)
37+
- [ValidationError ](api/ValidationError.md)
38+
- [Change Log](../CHANGELOG.md)

docs/basics/validating-objects.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# Validating objects
22

33
```ts
4-
import { validate, validateOrReject, IsString, IsInt, IsDate, MaxLength, Min, Max, ValidationError} from "class-validator";
4+
import {
5+
validate,
6+
validateOrReject,
7+
IsString,
8+
IsInt,
9+
IsDate,
10+
MaxLength,
11+
Min,
12+
Max,
13+
ValidationError,
14+
} from 'class-validator';
515

616
export class Book {
7-
817
@IsString()
918
@MaxLength(255)
1019
title: string;
@@ -20,7 +29,6 @@ export class Book {
2029

2130
@IsDate()
2231
publishDate: Date;
23-
2432
}
2533

2634
const book = new Book();
@@ -31,12 +39,12 @@ book.publishDate = new Date();
3139

3240
validate(book).then((errors: ValidationError[]) => {
3341
if (errors.length > 0) {
34-
console.warn("validate() - Validation failed. Errors: ", errors);
42+
console.warn('validate() - Validation failed. Errors: ', errors);
3543
}
3644
});
3745

3846
validateOrReject(book).catch((errors: ValidationError[]) => {
39-
console.warn("validateOrReject() - Validation failed. Errors: ", errors);
47+
console.warn('validateOrReject() - Validation failed. Errors: ', errors);
4048
});
4149

4250
awaitExample();
@@ -45,9 +53,9 @@ async function awaitExample() {
4553
try {
4654
await validateOrReject(book);
4755
} catch (errors) {
48-
console.warn("Async validateOrReject() - Validation failed. Errors: ", errors);
56+
console.warn('Async validateOrReject() - Validation failed. Errors: ', errors);
4957
}
5058
}
5159
```
5260

53-
Run this example on [Stackblitz](https://stackblitz.com/edit/class-validator-simple-example-u9h1ve?file=index.ts)
61+
Run this example on [Stackblitz](https://stackblitz.com/edit/class-validator-simple-example-u9h1ve?file=index.ts)

docs/introduction/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ You can install the next version of `class-validator` via
1818
npm install --save class-validator@next
1919
```
2020

21-
> Note: The next version can break anytime without notice. Do not use this in production.
21+
> Note: The next version can break anytime without notice. Do not use this in production.
+36-25
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,49 @@
1-
import {Contains, IsInt, MinLength, MaxLength, IsEmail, IsFQDN, IsDate, ArrayNotEmpty, ArrayMinSize, ArrayMaxSize, IsEnum} from "../../src/decorator/decorators";
1+
import {
2+
Contains,
3+
IsInt,
4+
MinLength,
5+
MaxLength,
6+
IsEmail,
7+
IsFQDN,
8+
IsDate,
9+
ArrayNotEmpty,
10+
ArrayMinSize,
11+
ArrayMaxSize,
12+
IsEnum,
13+
} from '../../src/decorator/decorators';
214

315
export enum PostType {
4-
Public,
5-
Private
16+
Public,
17+
Private,
618
}
719

820
export class Post {
21+
@MinLength(10)
22+
@MaxLength(20)
23+
title: string;
924

10-
@MinLength(10)
11-
@MaxLength(20)
12-
title: string;
25+
@Contains('hello')
26+
text: string;
1327

14-
@Contains("hello")
15-
text: string;
28+
@IsInt()
29+
rating: number;
1630

17-
@IsInt()
18-
rating: number;
31+
@IsEmail()
32+
email: string;
1933

20-
@IsEmail()
21-
email: string;
34+
@IsFQDN()
35+
site: string;
2236

23-
@IsFQDN()
24-
site: string;
37+
@IsDate()
38+
createDate: Date;
2539

26-
@IsDate()
27-
createDate: Date;
40+
@ArrayNotEmpty()
41+
@ArrayMinSize(2)
42+
@ArrayMaxSize(5)
43+
@MinLength(3, { each: true, message: 'Tag is too short. Minimal length is $value characters' })
44+
@MaxLength(50, { each: true, message: 'Tag is too long. Maximal length is $value characters' })
45+
tags: string[];
2846

29-
@ArrayNotEmpty()
30-
@ArrayMinSize(2)
31-
@ArrayMaxSize(5)
32-
@MinLength(3, { each: true, message: "Tag is too short. Minimal length is $value characters" })
33-
@MaxLength(50, { each: true, message: "Tag is too long. Maximal length is $value characters" })
34-
tags: string[];
35-
36-
@IsEnum(PostType)
37-
type: PostType;
47+
@IsEnum(PostType)
48+
type: PostType;
3849
}

0 commit comments

Comments
 (0)