Test a Map to be not empty.
Invert the following validators.
Register a new validator.
Validator to register.
Test a Map to be deeply equal to the provided Map.
Expected Map to match.
Test a Map to include any of the provided keys. The keys are tested by identity, not structure.
Rest
...keys: readonly T1[]The keys that could be a key in the Map.
Test a Map to include any of the provided values. The values are tested by identity, not structure.
Rest
...values: readonly T2[]The values that could be a value in the Map.
Test a Map to include all the provided keys. The keys are tested by identity, not structure.
Rest
...keys: readonly T1[]The keys that should be a key in the Map.
Test a Map to include all the provided values. The values are tested by identity, not structure.
Rest
...values: readonly T2[]The values that should be a value in the Map.
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.
Test all the keys in the Map to match the provided predicate.
The predicate that should be applied against every key in the Map.
Test an Map to have a maximum size.
The maximum size of the Map.
Provide a new error message to be thrown when the validation fails.
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 `🌈`
Either a string containing the new message or a function returning the new message.
Test an Map to have a minimum size.
The minimum size of the Map.
Test a Map to have a specific size.
The size of the Map.
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.
Test all the values in the Map to match the provided predicate.
The predicate that should be applied against every value in the Map.
Test a Map to be empty.