docs: Document Error ensure option

medikoo · Feb 18, 2021 · 6fda8ce · 6fda8ce
1 parent 3983ae2
commit 6fda8ce
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -68,6 +68,7 @@ Each `*/ensure` utility, accepts following options (eventually passed with secon
   - `%v` - To be replaced with short string representation of invalid value
   - `%n` - To be replaced with meaninfgul name (to be passed with `name` option) of validated value. Not effective if `name` option is not present
 - `name` - Meaningful name for validated value, to be used in error message, assuming it contains `%n` placeholder
+- `Error` - Alternative error constructor to be used (defaults to `TypeError`)
 
 ### Index