Class Fraction

Index

Constructors

Properties

Accessors

config config quotient remainder asFraction

Methods

setConfig parse tryParse invert negate abs expandDecimals normalizeDecimals shl shr isZero isInteger eq neq lt lte gt gte add sub mul div toFixed toPrecision toExponential toFormat toJSON

Constructors

constructor

new Fraction(numerator, denominator?): Fraction

Creates a new Fraction instance.

Parameters

numerator: FractionIsh
The numerator of the fraction.
Optional denominator: FractionIsh
The denominator of the fraction. (default: 1n)

Returns Fraction

Throws

If the numerator or denominator is not a valid NumberIsh.
If denominator is zero.

const a = new Fraction(1.23);
const b = new Fraction('1.23');
const c = new Fraction(123, 100);
const d = new Fraction(123n, 100n);
const e = new Fraction(123n, 100n);
const f = new Fraction(1230n, 1000n);
const g = new Fraction(a);

a.eq(b); // true
a.eq(c); // true
a.eq(d); // true
a.eq(e); // true
a.eq(f); // true
a.eq(g); // true

new Fraction('abc'); // throws
new Fraction('invalid NumberIsh'); // throws

Properties

`Static` `Readonly` ZERO

ZERO: Fraction = ...

`Static` `Readonly` ONE

ONE: Fraction = ...

`Readonly` numerator

numerator: bigint

The numerator of the fraction.

`Readonly` denominator

denominator: bigint

The denominator of the fraction.

`Static` `Private` _config

_config: Config = DEFAULT_CONFIG

Accessors

`Static` config

get config(): Config
Returns the current configuration.

Returns Config
- Defined in fraction.ts:326

`Private` config

get config(): Config
private instance getter.

Returns Config
- Defined in fraction.ts:342

quotient

get quotient(): bigint
Gets the quotient of the fraction (the integer part of the division).

Returns bigint
The quotient of the fraction.
```
new Fraction('123.789').quotient; // 123n
new Fraction('0.789').quotient; // 0n
```
- Defined in fraction.ts:469

remainder

get remainder(): Fraction

Gets the remainder of the fraction as a new Fraction instance.

Returns Fraction

A Fraction instance representing the remainder of the division.

const a = new Fraction(3, 2).remainder;
const b = new Fraction(1, 2);
a.eq(b); // true

const c = new Fraction('123.789').remainder;
const d = new Fraction(123789 % 1000, 1000);
c.eq(d); // true

asFraction

get asFraction(): Fraction
Helper method for converting any super class back to a fraction

Returns Fraction
A Fraction instance representing the current fraction.
- Defined in fraction.ts:1000

Methods

`Static` setConfig

setConfig(c): void
Sets the configuration by merging with the provided partial configuration.
Parameters
- c: Partial<Config>
  The partial configuration to merge.
Returns void
The updated configuration.
- Defined in fraction.ts:335

`Static` `Private` parse

parse(value): [bigint, bigint]
Creates a Fraction instance by parsing a numeric string.
Parameters
- value: FractionIsh
  The value to parse.
Returns [bigint, bigint]
[bigint, bigint] representing the successfully parsed Fraction numerator and denominator.

Throws
If value is not a valid NumberIsh.
- Defined in fraction.ts:352

`Static` tryParse

tryParse(value): undefined | Fraction
Tries to parse the given value as a Fraction
Parameters
- value: FractionIsh
  The value to parse.
Returns undefined | Fraction
The parsed Fraction value, or undefined if value is not a valid NumberIsh.
```
const a = new Fraction('1.23');
const b = Fraction.tryParse('1.23');
a.eq(b); // true

const c = Fraction.tryParse('abc');
c === undefined // true

new Fraction('abc'); // throws
```
- Defined in fraction.ts:402

invert

invert(): Fraction

Inverts the fraction by swapping the numerator and denominator.

Returns Fraction

The inverted fraction.

new Fraction('0.5').invert().eq(2); // true
new Fraction('0.25').invert().eq(4); // true
new Fraction(1, 3).invert().eq(3); // true
new Fraction(0).invert().eq(0); // true

negate

negate(): Fraction

Negates the sign of the Fraction.

Returns Fraction

The Fraction with the sign inverted.

new Fraction('123').negate().eq('-123'); // true

const a = new Fraction('123.456');
const b = new Fraction('-123.456');
a.negate().eq(b); // true

abs

abs(): Fraction
Returns the absolute value of the fraction.

Returns Fraction
A new Fraction instance representing the absolute value of the fraction.
```
new Fraction('-123').abs().eq('123');
```
- Defined in fraction.ts:532

expandDecimals

expandDecimals(decimals): Fraction
Parameters
- decimals: number
  The number of decimal places to expand.
Returns Fraction
A new Fraction instance representing the expanded fraction.
Deprecated
Use Fraction.shl instead.

Expands the fraction by multiplying it by 10 raised to the specified decimal places.

Throws
If n is not a positive integer.
```
new Fraction(1).expandDecimals(3).eq(1000); // true
new Fraction(1).expandDecimals(4).eq(1000); // true
new Fraction('123').expandDecimals(18).eq(123n * 10n ** 18n); // true
```
- Defined in fraction.ts:558

normalizeDecimals

normalizeDecimals(decimals): Fraction
Parameters
- decimals: number
  The number of decimal places to normalize.
Returns Fraction
A new Fraction instance representing the normalized fraction.
Deprecated
Use Fraction.shr instead.

Normalizes the fraction by dividing it by 10 raised to the specified decimal places.

Throws
If n is not a positive integer.
```
new Fraction(1000).normalizeDecimals(3).eq(1); // true
new Fraction(1000).normalizeDecimals(4).eq(0.1); // true
new Fraction('123e18').normalizeDecimals(18).eq(123); // true
```
- Defined in fraction.ts:580

shl

shl(n): Fraction
(Shift Left) Shift the fraction left by n places.
Parameters
- n: number
  The number of places to shift the Fraction by.
Returns Fraction
A new Fraction representing the result of the left shift operation.
Throws
If n is not a positive integer.
```
new Fraction(1).shl(3).eq(1000); // true
new Fraction(1).shl(4).eq(1000); // true
new Fraction('123').expandDecimals(18).eq(123n * 10n ** 18n); // true
```
- Defined in fraction.ts:599

shr

shr(n): Fraction
(Shift Right) Shift the fraction right by n places.
Parameters
- n: number
  The number of positions to shift the Fraction by.
Returns Fraction
A new Fraction representing the result of the right shift operation.
Throws
If n is not a positive integer.
```
new Fraction(1000).shr(3).eq(1); // true
new Fraction(1000).shr(4).eq(0.1); // true
new Fraction('123e18').normalizeDecimals(18).eq(123); // true
```
- Defined in fraction.ts:618

isZero

isZero(): boolean
Checks if the fraction is zero.

Returns boolean
True if the fraction is zero, false otherwise.
```
new Fraction(0).isZero(); // true
new Fraction(100).isZero(); // false
```
- Defined in fraction.ts:634

isInteger

isInteger(): boolean
Checks if the fraction is an integer.

Returns boolean
True if the fraction is an integer, false otherwise.
```
new Fraction(1).isInteger(); // true
new Fraction(1.1).isInteger(); // false
```
- Defined in fraction.ts:647

eq

eq(other): boolean
Checks if the fraction is equal to other.
Parameters
- other: FractionIsh
  The value to compare with.
Returns boolean
True if the fraction is equal to other, false otherwise.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:657

neq

neq(other): boolean
Checks if the fraction is not equal to other.
Parameters
- other: FractionIsh
  The value to compare with.
Returns boolean
True if the fraction is not equal to other, false otherwise.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:671

lt

lt(other): boolean
Checks if the fraction is less than other.
Parameters
- other: FractionIsh
  The value to compare with.
Returns boolean
True if the fraction is less than other, false otherwise.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:682

lte

lte(other): boolean
Checks if the fraction is less than or equal to other.
Parameters
- other: FractionIsh
  The value to compare with.
Returns boolean
True if the fraction is less than or equal to other, false otherwise.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:696

gt

gt(other): boolean
Checks if the fraction is greater than other.
Parameters
- other: FractionIsh
  The value to compare with.
Returns boolean
True if the fraction is greater than other, false otherwise.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:710

gte

gte(other): boolean
Checks if the fraction is greater than or equal to other.
Parameters
- other: FractionIsh
  The value to compare with.
Returns boolean
True if the fraction is greater than or equal to other, false otherwise.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:724

add

add(other): Fraction
Adds other to the fraction.
Parameters
- other: FractionIsh
  The value to add.
Returns Fraction
A new Fraction representing the sum.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:738

sub

sub(other): Fraction
Subtracts other from the fraction.
Parameters
- other: FractionIsh
  The value to subtract.
Returns Fraction
A new Fraction representing the difference.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:753

mul

mul(other): Fraction
Multiplies the fraction by other.
Parameters
- other: FractionIsh
  The value to multiply by.
Returns Fraction
A new Fraction representing the product.

Throws
If other is not a valid NumberIsh
- Defined in fraction.ts:768

div

div(other): Fraction
Divides the fraction by other.
Parameters
- other: FractionIsh
  The value to divide by.
Returns Fraction
A new Fraction representing the quotient.
Throws
1. If other is not a valid NumberIsh.
2. other is zero.
- Defined in fraction.ts:785

toFixed

toFixed(decimalPlaces?, opts?): string
Converts the fraction to a fixed-point decimal string representation.
Parameters
- Optional decimalPlaces: number
  The number of decimal places to include. (default: 0)
- Optional opts: {
      decimalPlaces?: number;
      roundingMode?: RoundingMode;
      trailingZeros?: boolean;
      format?: {
          groupSize?: number;
          groupSeparator?: string;
          decimalSeparator?: string;
      };
  }
  - Optional decimalPlaces?: number
    The number of decimal places to round to when using the toFormat() method.
  - Optional roundingMode?: RoundingMode
    The rounding mode to be applied.
  - Optional trailingZeros?: boolean
    Determines whether trailing zeros are preserved.
  - Optional format?: {
        groupSize?: number;
        groupSeparator?: string;
        decimalSeparator?: string;
    }
    Formatting options for the Fraction.toFormat method.
    - Optional groupSize?: number
      The grouping size of the integer part, default to 3.
    - Optional groupSeparator?: string
      The grouping separator of the integer part, default to ,.
    - Optional decimalSeparator?: string
      The decimal separator, default to ..
Returns string
The fixed-point decimal string representation of the fraction.
Throws
If decimalPlaces is not a positive integer.
```
new Fraction('123.567').toFixed(); // '124'
new Fraction('123.567', { roundingMode: RoundingMode.ROUND_HALF_DOWN }).toFixed(); // '123'
new Fraction('123.567').toFixed(1); // '123.6'
new Fraction('123.567').toFixed(2); // '123.57'
new Fraction('123.567', { roundingMode: RoundingMode.ROUND_DOWN } ).toFixed(2); // '123.56'
new Fraction('123.567').toFixed(3); // '123.567'
new Fraction('123.567').toFixed(4); // '123.5670'
new Fraction('123.567').toFixed(5); // '123.56700'
new Fraction('123.567').toFixed(5, { trailingZeros: false }); // '123.567'
```
- Defined in fraction.ts:814

toPrecision

toPrecision(significantDigits?, opts?): string
Converts the fraction to a string representation with the specified significant digits.
Parameters
- Optional significantDigits: number
  The number of significant digits in the resulting string representation.
- Optional opts: {
  significantDigits?: number;
  roundingMode?: RoundingMode;
  }
  - Optional significantDigits?: number
    The number of significant digits to preserve when using the toPrecision() method.
  - Optional roundingMode?: RoundingMode
    The rounding mode.
Returns string
The string representation of the fraction with the specified number of significant digits.
Throws
If significantDigits is not a >= 1 integer.
```
new Fraction('1234.567').toPrecision(1); // '1000'
new Fraction('1234.567').toPrecision(2); // '1200'
new Fraction('1234.567').toPrecision(3); // '1230'
new Fraction('1234.567').toPrecision(4); // '1235'
new Fraction('1234.567').toPrecision(4, { roundingMode: RoundingMode.ROUND_DOWN }); // '1234'
new Fraction('1234.567').toPrecision(5); // '1234.6'
new Fraction('1234.567').toPrecision(6); // '1234.57'
new Fraction('1234.567').toPrecision(7); // '1234.567'
new Fraction('1234.567').toPrecision(8); // '1234.5670'
new Fraction('1234.567').toPrecision(9); // '1234.56700'
```
- Defined in fraction.ts:862

toExponential

toExponential(decimalPlaces?, opts?): string
Converts a Fraction to a string of exponential representation.
Parameters
- Optional decimalPlaces: number
  The number of decimal places in the resulting string.
- Optional opts: {
      decimalPlaces?: number;
      roundingMode?: RoundingMode;
      trailingZeros?: boolean;
  }
  - Optional decimalPlaces?: number
    The number of decimal places to round to when using the toExponential() method.
  - Optional roundingMode?: RoundingMode
    The rounding mode to be applied.
  - Optional trailingZeros?: boolean
    Determines whether trailing zeros are preserved when using the toExponential() method.
Returns string
The string of exponential representation of the fraction.
Throws
If decimalPlaces is not a positive integer.
```
new Fraction(0).toExponential() // '0e+0'
new Fraction(0).toExponential(1) // '0.0e+0'
new Fraction('0.0000001234').toExponential(4) // '1.2340e-7'
new Fraction(1234.5678).toExponential(1) // '1.2e+3'
new Fraction(-1234.5678).toExponential(1) // '-1.2e+3'
new Fraction(1234.5678).toExponential(3) // '1.235e+3'
new Fraction(1234.5678).toExponential(5) // '1.23457e+3'
new Fraction(10n ** 100n).toExponential(2) // '1.00e+100'
```
- Defined in fraction.ts:907

toFormat

toFormat(opts?): string
Converts the fraction to a formatted string representation.
Parameters
- Optional opts: {
      decimalPlaces?: number;
      roundingMode?: RoundingMode;
      trailingZeros?: boolean;
      format?: {
          groupSize?: number;
          groupSeparator?: string;
          decimalSeparator?: string;
      };
  }
  - Optional decimalPlaces?: number
    The number of decimal places to round to when using the toFormat() method.
  - Optional roundingMode?: RoundingMode
    The rounding mode to be applied.
  - Optional trailingZeros?: boolean
    Determines whether trailing zeros are preserved.
  - Optional format?: {
        groupSize?: number;
        groupSeparator?: string;
        decimalSeparator?: string;
    }
    Formatting options for the Fraction.toFormat method.
    - Optional groupSize?: number
      The grouping size of the integer part, default to 3.
    - Optional groupSeparator?: string
      The grouping separator of the integer part, default to ,.
    - Optional decimalSeparator?: string
      The decimal separator, default to ..
Returns string
The formatted string representation of the fraction.
```
new Fraction('1234.567').toFormat(); // '123,5'
new Fraction('1234.567').toFormat({ decimalPlaces: 1, format: { groupSeparator: '-' } }); // '123-4.6'
new Fraction('1234.567', {}).toFormat({ decimalPlaces: 1 }); // '123,4.6'
new Fraction('1234.567', {}).toFormat({ decimalPlaces: 1, roundingMode: RoundingMode.ROUND_DOWN }); // '123,4.5'
```
- Defined in fraction.ts:953

toJSON

toJSON(): {
numerator: string;
denominator: string;
}
Converts the Fraction object to a JSON representation for avoiding serialization errors.

Returns {
numerator: string;
denominator: string;
}
- numerator: string
- denominator: string
- Defined in fraction.ts:1007

Class Fraction

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

numerator: FractionIsh

Optional denominator: FractionIsh

Returns Fraction

Throws

Properties

Static Readonly ZERO

Static Readonly ONE

Readonly numerator

Readonly denominator

Static Private _config

Accessors

Static config

Returns Config

Private config

Returns Config

quotient

Returns bigint

remainder

Returns Fraction

asFraction

Returns Fraction

Methods

Static setConfig

Parameters

c: Partial<Config>

Returns void

Static Private parse

Parameters

value: FractionIsh

Returns [bigint, bigint]

Throws

Static tryParse

Parameters

value: FractionIsh

Returns undefined | Fraction

invert

Returns Fraction

negate

Returns Fraction

abs

Returns Fraction

expandDecimals

Parameters

decimals: number

Returns Fraction

Deprecated

Throws

normalizeDecimals

Parameters

decimals: number

Returns Fraction

Deprecated

Throws

shl

Parameters

n: number

Returns Fraction

Throws

shr

Parameters

n: number

Returns Fraction

Throws

isZero

Returns boolean

isInteger

Returns boolean

eq

Parameters

other: FractionIsh

Returns boolean

`Optional` denominator: FractionIsh

`Static` `Readonly` ZERO

`Static` `Readonly` ONE

`Readonly` numerator

`Readonly` denominator

`Static` `Private` _config

`Static` config

`Private` config

`Static` setConfig

`Static` `Private` parse

`Static` tryParse

`Optional` decimalPlaces: number

`Optional` opts: {
decimalPlaces?: number;
roundingMode?: RoundingMode;
trailingZeros?: boolean;
format?: {
groupSize?: number;
groupSeparator?: string;
decimalSeparator?: string;
};
}

`Optional` decimalPlaces?: number

`Optional` roundingMode?: RoundingMode

`Optional` trailingZeros?: boolean

`Optional` format?: {
groupSize?: number;
groupSeparator?: string;
decimalSeparator?: string;
}

`Optional` groupSize?: number

`Optional` groupSeparator?: string

`Optional` decimalSeparator?: string

`Optional` significantDigits: number

`Optional` opts: {
significantDigits?: number;
roundingMode?: RoundingMode;
}

`Optional` significantDigits?: number

`Optional` roundingMode?: RoundingMode