Skip to main content

Function: equals()

equals<T>(expected, errorMessage?): Validator<T, T, string>

Defined in: validation/validators/index.ts:422

Validates value equals expected value.

Type Parameters​

T​

T

Parameters​

expected​

T

Expected value

errorMessage?​

string

Custom error message (optional)

Returns​

Validator<T, T, string>

Validator that checks equality

Example​

equals('yes')('yes') // => Valid('yes')
equals('yes')('no') // => Invalid(['Must equal: yes'])

// Useful for checkbox confirmations
equals(true, 'You must agree')