-
Notifications
You must be signed in to change notification settings - Fork 772
/
ValidationError.ts
94 lines (86 loc) · 2.86 KB
/
ValidationError.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/**
* Validation error description.
*/
export class ValidationError {
/**
* Object that was validated.
*
* OPTIONAL - configurable via the ValidatorOptions.validationError.target option
*/
target?: object;
/**
* Object's property that haven't pass validation.
*/
property: string;
/**
* Value that haven't pass a validation.
*
* OPTIONAL - configurable via the ValidatorOptions.validationError.value option
*/
value?: any;
/**
* Constraints that failed validation with error messages.
*/
constraints?: {
[type: string]: string;
};
/**
* Contains all nested validation errors of the property.
*/
children?: ValidationError[];
/*
* A transient set of data passed through to the validation result for response mapping
*/
contexts?: {
[type: string]: any;
};
/**
*
* @param shouldDecorate decorate the message with ANSI formatter escape codes for better readability
* @param hasParent true when the error is a child of an another one
* @param parentPath path as string to the parent of this property
* @param showConstraintMessages show constraint messages instead of constraint names
*/
toString(
shouldDecorate: boolean = false,
hasParent: boolean = false,
parentPath: string = ``,
showConstraintMessages: boolean = false
): string {
const boldStart = shouldDecorate ? `\x1b[1m` : ``;
const boldEnd = shouldDecorate ? `\x1b[22m` : ``;
const constraintsToString = () =>
(showConstraintMessages ? Object.values : Object.keys)(this.constraints ?? {}).join(`, `);
const propConstraintFailed = (propertyName: string): string =>
` - property ${boldStart}${parentPath}${propertyName}${boldEnd} has failed the following constraints: ${boldStart}${constraintsToString()}${boldEnd} \n`;
if (!hasParent) {
return (
`An instance of ${boldStart}${
this.target ? this.target.constructor.name : 'an object'
}${boldEnd} has failed the validation:\n` +
(this.constraints ? propConstraintFailed(this.property) : ``) +
(this.children
? this.children
.map(childError => childError.toString(shouldDecorate, true, this.property, showConstraintMessages))
.join(``)
: ``)
);
} else {
// we format numbers as array indexes for better readability.
const formattedProperty = Number.isInteger(+this.property)
? `[${this.property}]`
: `${parentPath ? `.` : ``}${this.property}`;
if (this.constraints) {
return propConstraintFailed(formattedProperty);
} else {
return this.children
? this.children
.map(childError =>
childError.toString(shouldDecorate, true, `${parentPath}${formattedProperty}`, showConstraintMessages)
)
.join(``)
: ``;
}
}
}
}