Class Percent

Serializable representation of a Percent.

Hierarchy

Fraction
- Percent

Implements

PercentObject

Index

Constructors

constructor

new Percent(numerator: BigintIsh, denominator?: BigintIsh): Percent
Parameters
- numerator: BigintIsh
- Optional denominator: BigintIsh
Returns Percent
Inherited from Fraction.constructor
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:38

Properties

`Readonly` denominator

denominator: JSBI

`Readonly` isFraction

isFraction: true

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

`Readonly` isPercent

isPercent: true

This boolean prevents a fraction from being interpreted as a Percent

`Readonly` numerator

numerator: JSBI

`Static` `Readonly` ONE

ONE: Percent

`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 .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:93

denominatorStr

get denominatorStr(): string
Fraction denominator.

Returns string
Implementation of PercentObject.denominatorStr

Inherited from Fraction.denominatorStr
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:33

numeratorStr

get numeratorStr(): string
Fraction numerator.

Returns string
Implementation of PercentObject.numeratorStr

Inherited from Fraction.numeratorStr
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:32

quotient

get quotient(): JSBI
Performs floor division.

Returns JSBI
Inherited from Fraction.quotient
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:70

remainder

get remainder(): Fraction
Remainder after floor division.

Returns Fraction
Inherited from Fraction.remainder
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:74

Methods

add

add(other: Fraction | BigintIsh): Percent
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.add
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:54

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 .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:59

divide

divide(other: Fraction | BigintIsh): Percent
Divides this Fraction by another Fraction.
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.divide
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:57

equalTo

equalTo(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.equalTo
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:83

greaterThan

greaterThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.greaterThan
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:84

invert

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

Returns

Returns Percent
Overrides Fraction.invert
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:62

isNonZero

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

Returns

Returns boolean
Inherited from Fraction.isNonZero
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:103

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 .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:98

lessThan

lessThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.lessThan
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:82

multiply

multiply(other: Fraction | BigintIsh): Percent
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.multiply
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:56

subtract

subtract(other: Fraction | BigintIsh): Percent
Parameters
- other: Fraction | BigintIsh
Returns Percent
Overrides Fraction.subtract
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:55

toJSON

toJSON(): PercentObject
JSON representation of the Percent.

Returns PercentObject
Overrides Fraction.toJSON
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:44

`Static` fromBPS

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

Returns
Percent
Parameters
- bps: BigintIsh
Returns Percent
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:53

`Static` fromFraction

fromFraction(fraction: Fraction): Percent
Creates a Percent from a Fraction.
Parameters
- fraction: Fraction
Returns Percent
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:48

`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)
- Optional decimals: number
  
  Number of decimals of precision. (default 10)
Returns Percent
Overrides Fraction.fromNumber
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:34

`Static` fromObject

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

Returns
Parameters
- other: PercentObject
Returns Percent
Overrides Fraction.fromObject
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:40

`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 .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:55

`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 .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/percent.d.ts:69

Class Percent

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

numerator: BigintIsh

Optional denominator: BigintIsh

Returns Percent

Properties

Readonly denominator

Readonly isFraction

Readonly isPercent

Readonly numerator

Static Readonly ONE

Static Readonly ONE_HUNDRED

Static Readonly ZERO

Accessors

asFraction

Returns Fraction

denominatorStr

Returns string

numeratorStr

Returns string

quotient

Returns JSBI

remainder

Returns Fraction

Methods

add

Parameters

other: Fraction | BigintIsh

Returns Percent

compareTo

Parameters

other: Fraction

Returns 0 | 1 | -1

divide

Parameters

other: Fraction | BigintIsh

Returns Percent

equalTo

Parameters

other: Fraction | BigintIsh

Returns boolean

greaterThan

Parameters

other: Fraction | BigintIsh

Returns boolean

invert

Returns

Returns Percent

isNonZero

Returns

Returns boolean

isZero

Returns

Returns boolean

lessThan

Parameters

other: Fraction | BigintIsh

Returns boolean

multiply

Parameters

other: Fraction | BigintIsh

Returns Percent

subtract

Parameters

other: Fraction | BigintIsh

Returns Percent

toJSON

Returns PercentObject

Static fromBPS

Returns

Parameters

`Optional` denominator: BigintIsh

`Readonly` denominator

`Readonly` isFraction

`Readonly` isPercent

`Readonly` numerator

`Static` `Readonly` ONE

`Static` `Readonly` ONE_HUNDRED

`Static` `Readonly` ZERO

`Static` fromBPS

`Static` fromFraction

`Static` fromNumber

`Optional` decimals: number

`Static` fromObject

`Static` isFraction

`Static` isPercent