sindresorhus / ow

Function argument validation for humans
https://sindresorhus.com/ow/
MIT License
3.8k stars 105 forks source link

Add option to override/remove type label in error message #200

Open taylorjdawson opened 3 years ago

taylorjdawson commented 3 years ago

Currently when a predicate is failed by returning a message the type is pre-pended to the message like so:

const greaterThan = (max: number, x: number) => {
    return x > max || `Expected \`${x}\` to be greater than \`${max}\``;
};

ow(5, ow.number.is(x => greaterThan(10, x)));
// => ArgumentError: (number) Expected `5` to be greater than `10`

and if a custom label is added:

ow(5, 'custom label', ow.number.is(x => greaterThan(10, x)));
// => ArgumentError: (number `custom label`) Expected `5` to be greater than `10`

I would love the option to override/remove as I want to send this error message back to the client and having the type there would be context leak e.g. the client has no need to know backend type implementations.

sindresorhus commented 3 years ago

Any suggestions on how to best resolve this?

taylorjdawson commented 3 years ago

What about the option to call ow without a type?

ow(5, ow.is(x => greaterThan(10, x)));
// => ArgumentError: Expected `5` to be greater than `10`

ow(5, 'custom label', ow.is(x => greaterThan(10, x)));
// => ArgumentError: (custom label) Expected `5` to be greater than `10`