GitHub
TwitterformatErrors
formatErrors(errors, format)
Processes errors (only items that match the Errors type) and
converts items to a structure defined by format.
formatErrors( [ "is required", { message: "is invalid" } ], "errors" );
Parameters
Returns
{Array|Object}:
The errors either flattened into a single array, grouped in
by key in an object, or a single array of Error items. If no
format is passed, errors will be returned in the raw parsed format.
Usage
The errors value should match the possible Errors type.
Given the following...
// validate this object
const person = {};
// against these constraints
const constraints = {
age: {
required: true,
number: true
}
};
// will return some errors
const errors = someValidator( person, constraints );//> ["is required", "must be a number"]
We can expect the following responses
Object Example
If no key exists in the error response, an array like object will be created.
{
"0": ["is required", "must be a number"]
}
Flat Example
[
"is required",
"must be a number"
]
Errors Example
If a key name exists in the error response, then we can expect to see the key name
in related.
[
{ "message": "is required", "related": []},
{ "message": "must be a number", "related": []}
]
Handling errors without related
Given the following errors object
[
"is required",
{"message": "must be a number"},
{"message": "must be a number", "related": ["zipCode"]}
]
Because only one item in the array has a related property, the other two items
will be grouped together by assigning them the wildcard (*) key. Once processed,
the errors will look like
[
{"message": "is required", "related": ["*"]},
{"message": "must be a number", "related": ["*"]},
{"message": "must be a number", "related": ["zipCode"]}
]