validatePositiveIntegersIncludingZero

Description

It validates the integer number if it's positive or 0. Promise will resolve the integer if valid, else, it will reject PositiveIncludingZeroValidationError.

Parameter List	Returns	Rejection Errors
`supposedPositiveIncludingZeroInteger: number` `tuple: Array (optional)`	`Promise<number \|\| Array>`	`PositiveIncludingZeroValidationError`
Related Functions	Function Signature
`validateIntegerFrom` `filterResolutionParam`	`function validatePositiveIntegersIncludingZero(number[, tuple]): Promise<number \|\| Array>`

Examples

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

validatePositiveIntegersIncludingZero(100).then((validatedInteger) =>
  console.log(validatedInteger)
); // prints 100

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

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

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

const run = async () => {
  try {
    const positiveIncludingZeroNumber =
      await validatePositiveIntegersIncludingZero(100);

    console.log(positiveIncludingZeroNumber); // prints 0
  } catch (e) {
    console.log(e);
  }
};

run();

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

const run = async () => {
  try {
    const positiveIncludingZeroNumber =
      await validatePositiveIntegersIncludingZero(-1);

    console.log(positiveIncludingZeroNumber); // Because number is negative, it will throw
  } catch (e) {
    // Throws an PositiveIntegersIncludingZeroError
    console.log(e);
  }
};

run();