@@ -8,14 +8,14 @@ export type PostFormatter = import("./validate").PostFormatter;
8
8
export type SchemaUtilErrorObject = import ( "./validate" ) . SchemaUtilErrorObject ;
9
9
declare class ValidationError extends Error {
10
10
/**
11
- * @param {Array<SchemaUtilErrorObject> } errors
12
- * @param {Schema } schema
13
- * @param {ValidationErrorConfiguration } configuration
11
+ * @param {Array<SchemaUtilErrorObject> } errors array of error objects
12
+ * @param {Schema } schema schema
13
+ * @param {ValidationErrorConfiguration } configuration configuration
14
14
*/
15
15
constructor (
16
16
errors : Array < SchemaUtilErrorObject > ,
17
17
schema : Schema ,
18
- configuration ?: ValidationErrorConfiguration
18
+ configuration ?: ValidationErrorConfiguration ,
19
19
) ;
20
20
/** @type {Array<SchemaUtilErrorObject> } */
21
21
errors : Array < SchemaUtilErrorObject > ;
@@ -28,47 +28,47 @@ declare class ValidationError extends Error {
28
28
/** @type {PostFormatter | null } */
29
29
postFormatter : PostFormatter | null ;
30
30
/**
31
- * @param {string } path
32
- * @returns {Schema }
31
+ * @param {string } path path
32
+ * @returns {Schema } schema
33
33
*/
34
34
getSchemaPart ( path : string ) : Schema ;
35
35
/**
36
- * @param {Schema } schema
37
- * @param {boolean } logic
38
- * @param {Array<Object > } prevSchemas
39
- * @returns {string }
36
+ * @param {Schema } schema schema
37
+ * @param {boolean } logic logic
38
+ * @param {Array<object > } prevSchemas prev schemas
39
+ * @returns {string } formatted schema
40
40
*/
41
41
formatSchema (
42
42
schema : Schema ,
43
43
logic ?: boolean ,
44
- prevSchemas ?: Array < Object >
44
+ prevSchemas ?: Array < object > ,
45
45
) : string ;
46
46
/**
47
- * @param {Schema= } schemaPart
48
- * @param {(boolean | Array<string>)= } additionalPath
49
- * @param {boolean= } needDot
50
- * @param {boolean= } logic
51
- * @returns {string }
47
+ * @param {Schema= } schemaPart schema part
48
+ * @param {(boolean | Array<string>)= } additionalPath additional path
49
+ * @param {boolean= } needDot true when need dot
50
+ * @param {boolean= } logic logic
51
+ * @returns {string } schema part text
52
52
*/
53
53
getSchemaPartText (
54
54
schemaPart ?: Schema | undefined ,
55
55
additionalPath ?: ( boolean | Array < string > ) | undefined ,
56
56
needDot ?: boolean | undefined ,
57
- logic ?: boolean | undefined
57
+ logic ?: boolean | undefined ,
58
58
) : string ;
59
59
/**
60
- * @param {Schema= } schemaPart
61
- * @returns {string }
60
+ * @param {Schema= } schemaPart schema part
61
+ * @returns {string } schema part description
62
62
*/
63
63
getSchemaPartDescription ( schemaPart ?: Schema | undefined ) : string ;
64
64
/**
65
- * @param {SchemaUtilErrorObject } error
66
- * @returns {string }
65
+ * @param {SchemaUtilErrorObject } error error object
66
+ * @returns {string } formatted error object
67
67
*/
68
68
formatValidationError ( error : SchemaUtilErrorObject ) : string ;
69
69
/**
70
- * @param {Array<SchemaUtilErrorObject> } errors
71
- * @returns {string }
70
+ * @param {Array<SchemaUtilErrorObject> } errors errors
71
+ * @returns {string } formatted errors
72
72
*/
73
73
formatValidationErrors ( errors : Array < SchemaUtilErrorObject > ) : string ;
74
74
}
0 commit comments