Class Percent

Serializable representation of a Percent.

Hierarchy

Fraction
- Percent

Implements

PercentObject

Index

Constructors

Properties

denominator isFraction isPercent numerator ONE ONE_HUNDRED ZERO

Accessors

asFraction denominatorStr numeratorStr quotient remainder

Methods

add compareTo divide equalTo greaterThan invert isNonZero isZero lessThan multiply subtract toJSON fromBPS fromFraction fromNumber fromObject isFraction isPercent

Constructors

constructor

new Percent(numerator: BigintIsh, denominator?: BigintIsh): Percent
Parameters
- numerator: BigintIsh
- denominator: BigintIsh = ONE
Returns Percent
Inherited from Fraction.constructor
- Defined in packages/fraction/src/fraction.ts:78

Properties

`Readonly` denominator

denominator: JSBI

`Readonly` isFraction

isFraction: true = true

This boolean checks to see if this is actually a Fraction.

`Readonly` isPercent

isPercent: true = true

This boolean prevents a fraction from being interpreted as a Percent

`Readonly` numerator

numerator: JSBI

`Static` `Readonly` ONE

ONE: Percent = ...

1%

`Static` `Readonly` ONE_HUNDRED

ONE_HUNDRED: Percent = ...

100% (1/1)

`Static` `Readonly` ZERO

ZERO: Percent = ...

Zero percent.

Accessors

asFraction

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

Returns Fraction
Inherited from Fraction.asFraction
- Defined in packages/fraction/src/fraction.ts:247

denominatorStr

get denominatorStr(): string
Fraction denominator.

Returns string
Implementation of PercentObject.denominatorStr

Inherited from Fraction.denominatorStr
- Defined in packages/fraction/src/fraction.ts:68

numeratorStr

get numeratorStr(): string
Fraction numerator.

Returns string
Implementation of PercentObject.numeratorStr

Inherited from Fraction.numeratorStr
- Defined in packages/fraction/src/fraction.ts:65

quotient

get quotient(): JSBI
Performs floor division.

Returns JSBI
Inherited from Fraction.quotient
- Defined in packages/fraction/src/fraction.ts:145

remainder

get remainder(): Fraction
Remainder after floor division.

Returns Fraction
Inherited from Fraction.remainder
- Defined in packages/fraction/src/fraction.ts:152

Methods

add

add(other: Fraction | BigintIsh): Percent
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.add
- Defined in packages/fraction/src/percent.ts:94

compareTo

compareTo(other: Fraction): 0 | 1 | -1
Compares this Fraction to the other Fraction.
Parameters
- other: Fraction
Returns 0 | 1 | -1
Inherited from Fraction.compareTo
- Defined in packages/fraction/src/fraction.ts:124

divide

divide(other: Fraction | BigintIsh): Percent
Divides this Fraction by another Fraction.
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.divide
- Defined in packages/fraction/src/percent.ts:106

equalTo

equalTo(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.equalTo
- Defined in packages/fraction/src/fraction.ts:209

greaterThan

greaterThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.greaterThan
- Defined in packages/fraction/src/fraction.ts:217

invert

invert(): Percent
Swaps the numerator and denominator of the Percent.

Returns

Returns Percent
Overrides Fraction.invert
- Defined in packages/fraction/src/percent.ts:114

isNonZero

isNonZero(): boolean
Returns true if this number (the numerator) is not equal to zero.

Returns

Returns boolean
Inherited from Fraction.isNonZero
- Defined in packages/fraction/src/fraction.ts:263

isZero

isZero(): boolean
Returns true if this number (the numerator) is equal to zero and the denominator is non-zero.

Returns

Returns boolean
Inherited from Fraction.isZero
- Defined in packages/fraction/src/fraction.ts:255

lessThan

lessThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.lessThan
- Defined in packages/fraction/src/fraction.ts:201

multiply

multiply(other: Fraction | BigintIsh): Percent
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.multiply
- Defined in packages/fraction/src/percent.ts:102

subtract

subtract(other: Fraction | BigintIsh): Percent
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.subtract
- Defined in packages/fraction/src/percent.ts:98

toJSON

toJSON(): PercentObject
JSON representation of the Percent.

Returns PercentObject
Overrides Fraction.toJSON
- Defined in packages/fraction/src/percent.ts:72

`Static` fromBPS

fromBPS(bps: BigintIsh): Percent
Parses a Percent from a given number of bps.

Returns
Percent
Parameters
- bps: BigintIsh
Returns Percent
- Defined in packages/fraction/src/percent.ts:90

`Static` fromFraction

fromFraction(fraction: Fraction): Percent
Creates a Percent from a Fraction.
Parameters
- fraction: Fraction
Returns Percent
- Defined in packages/fraction/src/percent.ts:82

`Static` fromNumber

fromNumber(number: number, decimals?: number): Percent
Parses a Percent from a float.

Returns
Percent
Parameters
- number: number
  
  Number to parse. (100% is 1.00)
- decimals: number = 10
  
  Number of decimals of precision. (default 10)
Returns Percent
Overrides Fraction.fromNumber
- Defined in packages/fraction/src/percent.ts:52

`Static` fromObject

fromObject(other: PercentObject): Percent
Constructs an Percent from a PercentObject.

Returns
Parameters
- other: PercentObject
Returns Percent
Overrides Fraction.fromObject
- Defined in packages/fraction/src/percent.ts:62

`Static` isFraction

isFraction(other: unknown): other is Fraction
Returns true if the other object is a Fraction.

Returns
Parameters
- other: unknown
Returns other is Fraction
Inherited from Fraction.isFraction
- Defined in packages/fraction/src/fraction.ts:112

`Static` isPercent

isPercent(other: unknown): other is Percent
Returns true if the other object is a Percent.

Returns
Parameters
- other: unknown
Returns other is Percent
- Defined in packages/fraction/src/percent.ts:124

Generated using TypeDoc