Register a new validator.
Validator to register.
Test a WeakSet to include all the provided items. The items are tested by identity, not structure.
Rest
...items: readonly T[]The items that should be a item in the WeakSet.
Test a WeakSet to include any of the provided items. The items are tested by identity, not structure.
Rest
...items: readonly T[]The items that could be a item in the WeakSet.
Test if the value matches a custom validation function. The validation function should return true
if the value passes the function. If the function either returns false
or a string, the function fails and the string will be used as error message.
Validation function.
Provide a new error message to be thrown when the validation fails.
Either a string containing the new message or a function returning the new message.
ow('🌈', 'unicorn', ow.string.equals('🦄').message('Expected unicorn, got rainbow'));
//=> ArgumentError: Expected unicorn, got rainbow
ow('🌈', ow.string.minLength(5).message((value, label) => `Expected ${label}, to have a minimum length of 5, got \`${value}\``));
//=> ArgumentError: Expected string, to be have a minimum length of 5, got `🌈`
Test if the value matches a custom validation function. The validation function should return an object containing a validator
and message
. If the validator
is false
, the validation fails and the message
will be used as error message. If the message
is a function, the function is invoked with the label
as argument to let you further customize the error message.
Custom validation function.
Invert the following validators.