Skip to content

assert

that

Signature

javascript
that(value, validator, errorMessage)

Description

Assert that a value passes validation

Parameters

NameTypeRequiredDescription
value*yesThe value to validate
validatorfunctionyesA function that returns true if the value is valid
errorMessagestringyesThe error message to throw if validation fails

Returns

TypeDescription
void

Examples

javascript
assert.that(5, (v) => v > 0, 'Value must be positive') // passes
assert.that(-1, (v) => v > 0, 'Value must be positive') // throws TypeError
assert.that('hello', (v) => typeof v === 'string', 'Must be a string') // passes

all

Signature

javascript
all(validations, validations[].value, validations[].validator, validations[].message)

Description

Assert multiple validations at once

Parameters

NameTypeRequiredDescription
validationsArray.<{value: *, validator: function(), message: string}>yesArray of validation objects
validations[].value*yesThe value to validate
validations[].validatorfunctionyesThe validator function
validations[].messagestringyesThe error message if validation fails

Returns

TypeDescription
void

Examples

javascript
assert.all([
  { value: 5, validator: (v) => v > 0, message: 'Must be positive' },
  { value: 'test', validator: (v) => v.length > 0, message: 'Must not be empty' }
]) // passes
javascript
assert.all([
  { value: 5, validator: (v) => v > 0, message: 'Must be positive' },
  { value: -1, validator: (v) => v > 0, message: 'Must be positive' }
]) // throws TypeError: 'Must be positive'