Function toPositiveNumber

  • toPositiveNumber(value): posnumber

  • Converts a number to a positive number type, throwing an error if negative.

    Parameters

    • value: number

      The number to convert.

    Returns posnumber

    • The value as a positive number type.

    Function

    toPositiveNumber

    Throws

    • Throws an error if the value is negative.

    Description

    Ensures the input is a non-negative number, branding it as posnumber.

    Example

    console.log(toPositiveNumber(5)); // Outputs: 5 (as posnumber)
    toPositiveNumber(-1); // Throws: "-1 is not a positive number"

Settings

Member Visibility