document emitDetailedErrors

Author: cauthmann

README.md

@@ -137,6 +137,7 @@ There are some options to configure the transformer.
 | `ignoreFunctions` *(deprecated, use `functionBehavior` instead)* | Boolean (default: `false`). If `true`, when the transformer encounters a function, it will ignore it and simply return `true`. If `false`, an error is generated at compile time. |
 | `functionBehavior` | One of `error`, `ignore`, or `basic` (default: `error`). Determines the behavior of transformer when encountering a function. `error` will cause a compile-time error, `ignore` will cause the validation function to always return `true`, and `basic` will do a simple function-type-check. Overrides `ignoreFunctions`. |
 | `disallowSuperfluousObjectProperties` | Boolean (default: `false`). If `true`, objects are checked for having superfluous properties and will cause the validation to fail if they do. If `false`, no check for superfluous properties is made. |
+| `emitDetailedErrors` | Boolean or `auto` (default: `auto`). The generated validation functions can return detailed error messages, pointing out where and why validation failed. These messages are used by `assertType<T>()`, but are ignored by `is<T>()`. If `false`, validation functions return empty error messages, decreasing code size. `auto` will generate detailed error messages for assertions, but not for type checks. `true` will always generate detailed error messages, matching the behaviour of version 0.18.3 and older. |
 
 If you are using `ttypescript`, you can include the options in your `tsconfig.json`:
 
@@ -150,7 +151,8 @@ If you are using `ttypescript`, you can include the options in your `tsconfig.js
                 "ignoreClasses": true,
                 "ignoreMethods": true,
                 "functionBehavior": "ignore",
-                "disallowSuperfluousObjectProperties": true
+                "disallowSuperfluousObjectProperties": true,
+                "emitDetailedErrors": "auto"
             }
         ]
     }