validateNegativeIntegersIncludingZero

Description

It resolves the parameter if it's an integer lower or equal 0. Rejects if the parameter isn't an integer or if integer is greater than 0.

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

Examples

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

validateNegativeIntegersIncludingZero(0).then((validatedInteger) =>
  console.log(validatedInteger)
); // prints 0

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

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

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

const run = async () => {
  try {
    const validatedNegativeInteger = await validateNegativeIntegersIncludingZero(0);

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

run();

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

const run = async () => {
  try {
    const validatedNegativeInteger = await validateNegativeIntegersIncludingZero(1);

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

run();