Documentation

A tree of Errors, with a single root Error and 0..n nested ErrorTrees.

top error
|
|-- error 1
| |
|  -- error 1.1
|
|-- error 2

Turn a single Error into an ErrorTree, a leaf.

Take a list of errors & create a new ErrorTree with the given Error as the root.

Attach more context to the root Error of the ErrorTree, via errorContext.

Nest the given Error around the ErrorTree

top level error
|
-- nestedError
  |
  -- error 1
  |
  -- error 2

Nest the given Error around the list of ErrorTrees.

top level error
|
|- nestedError1
| |
| -- error 1
| |
| -- error 2
|
|- nestedError 2

Sometimes, ErrorTrees can get very large. In that case, it’s recommended to first think about whether you can e.g. chunk the validation logic.

But even so, restricting the size of the ErrorTree before printing it is often a good idea.

This will make sure the given maxlength and maxdepth are not exceeded, and insert warnings if some subtree was elided.