Class NumberValidator

constructor

• new NumberValidator(number?, name?): NumberValidator

• Parameters

  • number: string | number = 0
  • name: string = 'number'

  Returns NumberValidator

name

number

• get number(): undefined | number

• Returns undefined | number

• set number(number): void

• Parameters

  • number: undefined | number

  Returns void

all

• all(numbers, name?): ArrayNumberValidator

• Returns an ArrayNumberValidator for all the numbers

  Parameters

  • numbers: number[]
  • Optionalname: string

  Returns ArrayNumberValidator

assertNumber

• assertNumber(num?): num is number

• Parameters

  • Optionalnum: number

  Returns num is number

between

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

• Asserts that the from < number < to

  Parameters

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

  Returns NumberValidator

  Throws

  NumberValidationError if it is outside or equal to those bounds

betweenEq

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

• Asserts that the from <= number <= to

  Parameters

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

  Returns NumberValidator

  Throws

  NumberValidationError if it is outside those bounds

gt

• gt(n, msg?): this

• Asserts that number > n

  Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if it is less than or equal to n

gteq

• gteq(n, msg?): this

• Asserts that number >= n

  Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if it is less than n

int

• int(msg?): this

• Asserts that the number is an integer

  Parameters

  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if ths number is not an integer

integer

• integer(msg?): this

• Parameters

  • Optionalmsg: string

  Returns this

lt

• lt(n, msg?): this

• Asserts that number < n

  Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if it is greater than or equal to n

lteq

• lteq(n, msg?): this

• Asserts that number <= n

  Parameters

  • n: number
  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if it is greater than n

negative

• negative(msg?): this

• Asserts that the number is < 0

  Parameters

  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if the number is not negative

positive

• positive(msg?): this

• Asserts that the number is > 0

  Parameters

  • Optionalmsg: string

  Returns this

  Throws

  NumberValidationError if the number is not positive

validate

• validate(number): ArrayNumberValidator | NumberValidator

• Specify the number to be validated

  Parameters

  • number: number | number[]

  Returns ArrayNumberValidator | NumberValidator

varname

• varname(name): NumberValidator

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

  Parameters

  • name: string

    [description]

  Returns NumberValidator

  Example

  const potato = 1;
  validate(potato).varname('potato').gt(2); // "Expected potato to be greater than 2, got 1"
  Copy