validateIntegerUntilLimit

Description

This function validates the integer that is lower or equal the limit parameter. For example, if limit is 10, the integer 9 would be valid wheras the 10 would be invalid.

Please, note that the tuple parameter isn't optional, so if you don't intend to use, it, assign it undefined.

Parameter List	Returns	Rejection Errors
`supposedInteger: *` `tuple: Array` `limit: number`	`Promise<number \|\| Array>`	`IntegerValidationErrorToValue`
Related Functions	Function Signature
`validateAllArgsInteger` `filterResolutionParam`	`function validateIntegerUntilLimit(supposedInteger, tuple, integer): Promise<number \|\| Array>`

Examples

import { validateIntegerUntilLimit } from "puddy-m/lib/validators/complexValidators";

validateIntegerUntilLimit(100, null, 101).then((validatedInteger) =>
  console.log(validatedInteger)
); // prints 100

import { validateString } from "puddy-m/lib/validators";
import { validateIntegerUntilLimit } from "puddy-m/lib/validators/complexValidators";

validateIntegerUntilLimit(100, [], 101)
  .then((tuple) => validateString("string", tuple))
  .then((tuple) => console.log(tuple)); // prints [100, 'string']

import { validateIntegerUntilLimit } from "puddy-m/lib/validators/complexValidators";

const run = async () => {
  try {
    const validatedInteger = await validateIntegerUntilLimit(100, null, 101);

    console.log(validatedInteger); // prints 100
  } catch (e) {
    console.log(e);
  }
};

run();

import { validateIntegerUntilLimit } from "puddy-m/lib/validators/complexValidators";

const run = async () => {
  try {
    const validatedInteger = await validateIntegerUntilLimit(100, null, 99);

    console.log(validatedInteger);
  } catch (e) {
    // Throws IntegerValidationErrorToValue
    console.log(e);
  }
};

run();