Library API
    Preparing search index...

    Function asNumber

    • Coerces a value to a finite number. Returns the finite number if valid, otherwise returns undefined (or an optional fallback).

      Parameters

      • val: unknown

        The value to coerce

      Returns number | undefined

      The coerced finite number or fallback

      asNumber(123);             // 123
      asNumber(123n); // 123
      asNumber('123.45'); // 123.45
      asNumber('abc'); // undefined
      asNumber('abc', 0); // 0
      asNumber(null, 1.0); // 1.0
    • Coerces a value to a finite number. Returns the finite number if valid, otherwise returns undefined (or an optional fallback).

      Parameters

      • val: unknown

        The value to coerce

      • fallback: undefined

        Optional fallback if val is not a finite number

      Returns number | undefined

      The coerced finite number or fallback

      asNumber(123);             // 123
      asNumber(123n); // 123
      asNumber('123.45'); // 123.45
      asNumber('abc'); // undefined
      asNumber('abc', 0); // 0
      asNumber(null, 1.0); // 1.0
    • Coerces a value to a finite number. Returns the finite number if valid, otherwise returns undefined (or an optional fallback).

      Type Parameters

      • T extends number

      Parameters

      • val: unknown

        The value to coerce

      • fallback: T

        Optional fallback if val is not a finite number

      Returns number

      The coerced finite number or fallback

      asNumber(123);             // 123
      asNumber(123n); // 123
      asNumber('123.45'); // 123.45
      asNumber('abc'); // undefined
      asNumber('abc', 0); // 0
      asNumber(null, 1.0); // 1.0
    • Coerces a value to a finite number. Returns the finite number if valid, otherwise returns undefined (or an optional fallback).

      Type Parameters

      • T

      Parameters

      • val: unknown

        The value to coerce

      • fallback: T

        Optional fallback if val is not a finite number

      Returns number | T

      The coerced finite number or fallback

      asNumber(123);             // 123
      asNumber(123n); // 123
      asNumber('123.45'); // 123.45
      asNumber('abc'); // undefined
      asNumber('abc', 0); // 0
      asNumber(null, 1.0); // 1.0