Class NumberCore

The core Number functions.

Since

v1.0.0

Index

Methods

assertBigInt assertFloat assertInt assertNumber bigIntFrom buildBigIntErr buildFloatErr buildIntErr buildNumberErr floatFrom intFrom isBigInt isFloat isInt isNumber numberFrom

Methods

`Static`assertBigInt

assertBigInt(value: unknown): asserts value is bigint
Asserts that the given value is a bigint.
Parameters
- value: unknown
  The value to assert.
Returns asserts value is bigint
Example
```
function add(a: bigint, b: bigint): bigint {
  NumberCore.assertBigInt(a);
  NumberCore.assertBigInt(b);
  return a + b;
}
```
Throws
If the given value is not a bigint.

Since
v1.0.4
- Defined in src/lib/NumberCore.mts:182

`Static`assertFloat

assertFloat(value: unknown): asserts value is number
Asserts that the given value is an float.
Parameters
- value: unknown
  The value to assert.
Returns asserts value is number
Example
```
function add(a: number, b: number): number {
  NumberCore.assertFloat(a);
  NumberCore.assertFloat(b);
  return a + b;
}
```
Throws
If the given value is not an float.

Since
v1.0.0
- Defined in src/lib/NumberCore.mts:98

`Static`assertInt

assertInt(value: unknown): asserts value is number
Asserts that the given value is an integer.
Parameters
- value: unknown
  The value to assert.
Returns asserts value is number
Example
```
function add(a: number, b: number): number {
  NumberCore.assertInt(a);
  NumberCore.assertInt(b);
  return a + b;
}
```
Throws
If the given value is not an integer.

Since
v1.0.0
- Defined in src/lib/NumberCore.mts:143

`Static`assertNumber

assertNumber(value: unknown): asserts value is number
Asserts that the given value is an integer or float value.
Parameters
- value: unknown
  The value to assert.
Returns asserts value is number
Example
```
function add(a: number, b: number): number {
  NumberCore.assertNumber(a);
  NumberCore.assertNumber(b);
  return a + b;
}
```
Throws
If the given value is not a number.

Since
v1.0.4
- Defined in src/lib/NumberCore.mts:53

`Static`bigIntFrom

bigIntFrom(value: Nullish<string | number | bigint>): bigint
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.

Throws
If the given value cannot be converted to a bigint.

Since
v1.0.4
- Defined in src/lib/NumberCore.mts:156

`Static`buildBigIntErr

buildBigIntErr(value: unknown): TypeError
Builds an type error Invalid bigint: ${JSON.stringify(value)}.
Parameters
- value: unknown
  The invalid value.
Returns TypeError
The created error.

Since
v1.0.4
- Defined in src/lib/NumberCore.mts:233

`Static`buildFloatErr

buildFloatErr(value: unknown): TypeError
Builds an type error Invalid float: ${JSON.stringify(value)}.
Parameters
- value: unknown
  The invalid value.
Returns TypeError
The created error.

Since
v1.0.0
- Defined in src/lib/NumberCore.mts:207

`Static`buildIntErr

buildIntErr(value: unknown): TypeError
Builds an type error Invalid integer: ${JSON.stringify(value)}.
Parameters
- value: unknown
  The invalid value.
Returns TypeError
The created error.

Since
v1.0.0
- Defined in src/lib/NumberCore.mts:220

`Static`buildNumberErr

buildNumberErr(value: unknown): TypeError
Builds an type error Invalid integer: ${JSON.stringify(value)}.
Parameters
- value: unknown
  The invalid value.
Returns TypeError
The created error.

Since
v1.0.4
- Defined in src/lib/NumberCore.mts:194

`Static`floatFrom

floatFrom(value: Nullish<string | number | bigint>): number
Get or create an float from the given value.
Parameters
- value: Nullish<string | number | bigint>
  The value to convert.
Returns number
The float value.
Throws
If the given value cannot be converted to an float.

Since
v1.0.0
Example
```
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);
}
```
- Defined in src/lib/NumberCore.mts:72

`Static`intFrom

intFrom(value: Nullish<string | number | bigint>): number
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.
Throws
If the given value cannot be converted to an integer.

Since
v1.0.0
Example
```
const value = NumberCore.intFrom('123');
const value = NumberCore.intFrom(123);
function add(a: number, b: number): number {
  return IntCore.intFrom(a) + IntCore.intFrom(b);
}
```
- Defined in src/lib/NumberCore.mts:117

`Static`isBigInt

isBigInt(value: unknown): value is bigint
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.

Since
v1.0.4
- Defined in src/lib/NumberCore.mts:166

`Static`isFloat

isFloat(value: unknown): value is number
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.

Since
v1.0.0
- Defined in src/lib/NumberCore.mts:82

`Static`isInt

isInt(value: unknown): value is number
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.

Since
v1.0.0
- Defined in src/lib/NumberCore.mts:127

`Static`isNumber

isNumber(value: unknown): value is number
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.
Since
v1.0.4
Example
```
if (NumberCore.isNumber(value)) {
  // value is a number
}
```
- Defined in src/lib/NumberCore.mts:37

`Static`numberFrom

numberFrom(value: Nullish<string | number | bigint>): 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.
Throws
If the given value cannot be converted to an number.

Since
v1.0.4
Example
```
const value = NumberCore.numberFrom('123');
const value = NumberCore.numberFrom(123);
function add(a: number, b: number): number {
  return NumberCore.numberFrom(a) + NumberCore.numberFrom(b);
}
```
- Defined in src/lib/NumberCore.mts:23

Class NumberCore

Since

Index

Methods

Methods

StaticassertBigInt

Parameters

Returns asserts value is bigint

Example

Throws

Since

StaticassertFloat

Parameters

Returns asserts value is number

Example

Throws

Since

StaticassertInt

Parameters

Returns asserts value is number

Example

Throws

Since

StaticassertNumber

Parameters

Returns asserts value is number

Example

Throws

Since

StaticbigIntFrom

Parameters

Returns bigint

Throws

Since

StaticbuildBigIntErr

Parameters

Returns TypeError

Since

StaticbuildFloatErr

Parameters

Returns TypeError

Since

StaticbuildIntErr

Parameters

Returns TypeError

Since

StaticbuildNumberErr

Parameters

Returns TypeError

Since

StaticfloatFrom

Parameters

Returns number

Throws

Since

Example

StaticintFrom

Parameters

Returns number

Throws

Since

Example

StaticisBigInt

Parameters

Returns value is bigint

Since

StaticisFloat

Parameters

Returns value is number

Since

StaticisInt

Parameters

Returns value is number

Since

StaticisNumber

Parameters

Returns value is number

Since

Example

StaticnumberFrom

`Static`assertBigInt

`Static`assertFloat

`Static`assertInt

`Static`assertNumber

`Static`bigIntFrom

`Static`buildBigIntErr

`Static`buildFloatErr

`Static`buildIntErr

`Static`buildNumberErr

`Static`floatFrom

`Static`intFrom

`Static`isBigInt

`Static`isFloat

`Static`isInt

`Static`isNumber

`Static`numberFrom