@luolapeikko/ts-common
    Preparing search index...

    Class NumberCore

    The core Number functions.

    v1.0.0

    Index

    Methods

    assertBigInt assertFloat assertInt assertNumber bigIntFrom buildCustomError buildValueErr floatFrom intFrom isBigInt isFloat isInt isNumber numberFrom

    Methods

    • Asserts that the given value is a bigint.

      Parameters

      • value: unknown

        The value to assert.

      Returns asserts value is bigint

      function add(a: bigint, b: bigint): bigint {
        NumberCore.assertBigInt(a);
        NumberCore.assertBigInt(b);
        return a + b;
      }

      If the given value is not a bigint.

      v1.0.4

    • Asserts that the given value is an float.

      Parameters

      • value: unknown

        The value to assert.

      Returns asserts value is number

      function add(a: number, b: number): number {
        NumberCore.assertFloat(a);
        NumberCore.assertFloat(b);
        return a + b;
      }

      If the given value is not an float.

      v1.0.0

    • Asserts that the given value is an integer.

      Parameters

      • value: unknown

        The value to assert.

      Returns asserts value is number

      function add(a: number, b: number): number {
        NumberCore.assertInt(a);
        NumberCore.assertInt(b);
        return a + b;
      }

      If the given value is not an integer.

      v1.0.0

    • Asserts that the given value is an integer or float value.

      Parameters

      • value: unknown

        The value to assert.

      Returns asserts value is number

      function add(a: number, b: number): number {
        NumberCore.assertNumber(a);
        NumberCore.assertNumber(b);
        return a + b;
      }

      If the given value is not a number.

      v1.0.4

    • Get or create a bigint from the given value. (Note: on float conversion, Math.trunc() is used)

      Parameters

      • value: Nullish<string | number | bigint>

        The value to convert.

      Returns bigint

      The bigint value.

      If the given value cannot be converted to a bigint.

      v1.0.4

    • Parameters

      • message: string
      • typeName: "Number" | "Integer" | "Float" | "BigInt"

      Returns string

    • Builds value error.

      Parameters

      • value: unknown

        The invalid value.

      • typeName: "Number" | "Integer" | "Float" | "BigInt"

        The expected type name.

      • OptionalisNot: boolean = false

        Whether the error should be for !${typeName}.

      Returns TypeError

      The created error.

      v1.1.2

    • Get or create an float from the given value.

      Parameters

      • value: Nullish<string | number | bigint>

        The value to convert.

      Returns number

      The float value.

      If the given value cannot be converted to an float.

      v1.0.0

      const value = NumberCore.floatFrom('123.5');
      const value = NumberCore.floatFrom(123.5);
      function add(a: number, b: number): number {
        return NumberCore.floatFrom(a) + NumberCore.floatFrom(b);
      }

    • Get or create an integer from the given value. (Note: on float conversion, Math.trunc() is used)

      Parameters

      • value: Nullish<string | number | bigint>

        The value to convert.

      Returns number

      The integer value.

      If the given value cannot be converted to an integer.

      v1.0.0

      const value = NumberCore.intFrom('123');
      const value = NumberCore.intFrom(123);
      function add(a: number, b: number): number {
        return IntCore.intFrom(a) + IntCore.intFrom(b);
      }

    • Checks if the given value is a bigint.

      Parameters

      • value: unknown

        The value to check.

      Returns value is bigint

      True if the value is a bigint; otherwise, false.

      v1.0.4

    • Type guard check if the given value is an float.

      Parameters

      • value: unknown

        The value to check.

      Returns value is number

      True if the value is an float; otherwise, false.

      v1.0.0

    • Type guard check if the given value is an integer.

      Parameters

      • value: unknown

        The value to check.

      Returns value is number

      True if the value is an integer; otherwise, false.

      v1.0.0

    • Type guard check if the given value is an integer or float value. (not NaN)

      Parameters

      • value: unknown

        The value to check.

      Returns value is number

      True if the value is a number; otherwise, false.

      v1.0.4

      if (NumberCore.isNumber(value)) {
        // value is a number
      }

    • Get or create an number from the given value. (can be float or int)

      Parameters

      • value: Nullish<string | number | bigint>

        The value to convert.

      Returns number

      The number value.

      If the given value cannot be converted to an number.

      v1.0.4

      const value = NumberCore.numberFrom('123');
      const value = NumberCore.numberFrom(123);
      function add(a: number, b: number): number {
        return NumberCore.numberFrom(a) + NumberCore.numberFrom(b);
      }

    Settings

    Member Visibility

    On This Page

    Methods