TS-Scribe - v0.6.2
    Preparing search index...

    Function parseNumber

    • Parses a value and converts it to a number. The function handles multiple input types (string, number, null, or undefined) and can convert the input into either an integer or a float. If the input cannot be parsed, it returns a default value.

      Parameters

      • value: string | number | undefined

        The value to be parsed into a number.

      • defaultValue: number

        The default value to return if the value cannot be parsed.

      • Optionaltype: "int" | "float" = 'float'

        The type of number to return, either 'int' or 'float'. Defaults to 'float'.

      • OptionalthrowInvalid: boolean = false

        Whether to throw an error if parsing fails. If true, an error is thrown when invalid input is provided.

      Returns number

      The parsed number, or the default value if parsing fails.

      parseNumber('123'); // Returns 123
      parseNumber('123.45', 0, 'float'); // Returns 123.45
      parseNumber('123.45', 0, 'int'); // Returns 0 (because it's not an integer)
      parseNumber('abc', 0); // Returns 0 (invalid string)
      parseNumber(null, 42); // Returns 42
      parseNumber(undefined, 42); // Returns 42
      parseNumber('10', 0, 'int', true); // Returns 10 (valid integer)
      parseNumber('12.34', 0, 'int', true); // Throws an error (invalid for 'int')