Class ArrayNumberValidator

constructor

• new ArrayNumberValidator(numbers, name?): ArrayNumberValidator

• Parameters

  • numbers: number[]
  • name: string = 'numbers'

  Returns ArrayNumberValidator

name

numbers

• get numbers(): number[]

• Returns number[]

• set numbers(numbers): void

• Parameters

  • numbers: number[]

  Returns void

all

• all(numbers): this

• Specify the numbers to validate

  Parameters

  • numbers: number[]

  Returns this

between

• between(from, to, msg?): this

• Parameters

  • from: number
  • to: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all between from and to

betweenEq

• betweenEq(from, to, msg?): this

• Parameters

  • from: number
  • to: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all between or equal to from and to

gt

• gt(n, msg?): this

• Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all > n

gteq

• gteq(n, msg?): this

• Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all >= n

int

• int(msg?): this

• Parameters

  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all integers

lt

• lt(n, msg?): this

• Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all < n

lteq

• lteq(n, msg?): this

• Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all <= n

negative

• negative(msg?): this

• Parameters

  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all negative

positive

• positive(msg?): this

• Parameters

  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if numbers are not all positive

sum

• sum(): number

• Get the sum of our numbers

  Returns number

sumcloseto

• sumcloseto(sum, diff?, msg?): this

• Validates whether the total of all of our numbers is close to sum, with a maximum difference of diff

  Parameters

  • sum: number

    The sum
  • diff: number = 0.0001

    The maximum difference
  • Optionalmsg: string

    Error message

  Returns this

  Throws

  NumberValidationError If they do not sum close to the correct amount

sumto

• sumto(sum, msg?): this

• Validates whether the total of all of our numbers is equal (===) to sum

  Parameters

  • sum: number

    The sum
  • Optionalmsg: string

    Error message

  Returns this

  Throws

  NumberValidationError If they do not total to the correct amount

sumtogt

• sumtogt(sum, msg?): this

• Validates whether the total of all of our numbers is > sum

  Parameters

  • sum: number

    The sum
  • Optionalmsg: string

    Error message

  Returns this

  Throws

  NumberValidationError If they do not total to > sum

sumtogteq

• sumtogteq(sum, msg?): this

• Validates whether the total of all of our numbers is >= sum

  Parameters

  • sum: number

    The sum
  • Optionalmsg: string

    Error message

  Returns this

  Throws

  NumberValidationError If they do not total to >= sum

sumtolt

• sumtolt(sum, msg?): this

• Validates whether the total of all of our numbers is < sum

  Parameters

  • sum: number

    The sum
  • Optionalmsg: string

    Error message

  Returns this

  Throws

  NumberValidationError If they do not total to < sum

sumtolteq

• sumtolteq(sum, msg?): this

• Validates whether the total of all of our numbers is <= sum

  Parameters

  • sum: number

    The sum
  • Optionalmsg: string

    Error message

  Returns this

  Throws

  NumberValidationError If they do not total to <= sum

validate

• validate(numbers): ArrayNumberValidator | NumberValidator

• Specify the numbers to validate

  Parameters

  • numbers: number | number[]

  Returns ArrayNumberValidator | NumberValidator

varname

• varname(name): this

• Pass a string decribing the varname to this to make the error messages make more sense in your context.

  Parameters

  • name: string

  Returns this

  Example

  const potatoes = [0, 1];
  validate(potatoes).varname('potatoes').gt(2); // "Expected every component of potatoes to be > 2, got 0"
  Copy