Test an array to be not empty.
Invert the following validators.
Register a new validator.
Validator to register.
Test an array to be deeply equal to the provided array.
Expected value to match.
Test an array to end with a specific value. The value is tested by identity, not structure.
The value that should be the end of the array.
Test if the elements in the array exactly matches the elements placed at the same indices in the predicates array.
Predicates to test the array against. Describes what the tested array should look like.
ow(['1', 2], ow.array.exactShape([ow.string, ow.number]));
Test an array to include all the provided elements. The values are tested by identity, not structure.
Rest ...searchElements: readonly T[]The values that should be included in the array.
Test an array to include any of the provided elements. The values are tested by identity, not structure.
Rest ...searchElements: readonly T[]The values that should be included in the array.
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 all elements in the array to match to provided predicate.
The predicate that should be applied against every individual item.
ow(['a', 1], ow.array.ofType(ow.any(ow.string, ow.number)));
Test an array to start with a specific value. The value is tested by identity, not structure.
The value that should be the start of the array.
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 an array to be empty.