Class Ratio

Hierarchy

FixedPoint
- Ratio

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Ratio(amount: BN): Ratio

Inherited from Wei.constructor
- Defined in src/units.ts:14
Parameters
- amount: BN
Returns Ratio

Properties

Readonly amount

amount: BN

Static Readonly DIV

DIV: number = 1000000

Static Readonly DIV_BN

DIV_BN: BN = new BN(Ratio.DIV)

Methods

add

add(other: this): this

Inherited from Wei.add
- Defined in src/units.ts:25
Parameters
- other: this
Returns this

Protected check

check(other: FixedPoint, type?: Function): void

Inherited from Wei.check
- Defined in src/units.ts:127
Parameters
- other: FixedPoint
- Default value type: Function = this.constructor
Returns void

cmp

cmp(other: this): number

Inherited from Wei.cmp
- Defined in src/units.ts:86
Parameters
- other: this
Returns number

div

div(ratio: Ratio): this

Inherited from Wei.div
- Defined in src/units.ts:55
Parameters
- ratio: Ratio
Returns this

divFloor

divFloor(ratio: Ratio): this

Inherited from Wei.divFloor
- Defined in src/units.ts:62
Parameters
- ratio: Ratio
Returns this

divRound

divRound(ratio: Ratio): this

Inherited from Wei.divRound
- Defined in src/units.ts:68
Parameters
- ratio: Ratio
Returns this

divToRatio

divToRatio(other: this): Ratio

Inherited from Wei.divToRatio
- Defined in src/units.ts:73
Parameters
- other: this
Returns Ratio

eq

eq(other: this): boolean

Inherited from Wei.eq
- Defined in src/units.ts:91
Parameters
- other: this
Returns boolean

gte

gte(other: this): boolean

Inherited from Wei.gte
- Defined in src/units.ts:96
Parameters
- other: this
Returns boolean

isZero

isZero(): boolean

Inherited from Wei.isZero
- Defined in src/units.ts:82
Returns boolean

lte

lte(other: this): boolean

Inherited from Wei.lte
- Defined in src/units.ts:101
Parameters
- other: this
Returns boolean

mul

mul(ratio: Ratio): this

Inherited from Wei.mul
- Defined in src/units.ts:36
Parameters
- ratio: Ratio
Returns this

mulCeil

mulCeil(ratio: Ratio): this

Inherited from Wei.mulCeil
- Defined in src/units.ts:48
Parameters
- ratio: Ratio
Returns this

mulRound

mulRound(ratio: Ratio): this

Inherited from Wei.mulRound
- Defined in src/units.ts:42
Parameters
- ratio: Ratio
Returns this

sub

sub(other: this): this

Inherited from Wei.sub
- Defined in src/units.ts:30
Parameters
- other: this
Returns this

toJSON

toJSON(): string

Inherited from Wei.toJSON
- Defined in src/units.ts:114
Returns string

toNumber

toNumber(): number

- Defined in src/units.ts:220
Returns number

toString

toString(radix?: number): string

Inherited from Wei.toString
- Defined in src/units.ts:118
Parameters
- Default value radix: number = 10
Returns string

zeroToNull

zeroToNull(): this | null

Inherited from Wei.zeroToNull
- Defined in src/units.ts:110
Returns this | null

Static of

of(num: number): Ratio

- Defined in src/units.ts:216
Parameters
- num: number
Returns Ratio

Static parse

parse(str: string): Ratio

- Defined in src/units.ts:212
Parameters
- str: string
Returns Ratio

Generated using TypeDoc