Class Amount

Hierarchy

AmountBase
- Amount

Index

Constructors

Properties

Accessors

bn decimals isZero value

Methods

isGreaterThan isGreaterThanOrEqualTo isLessThan isLessThanOrEqualTo toJSON toString fromBN fromBigInt fromPlainObject fromRaw

Constructors

`Protected` constructor

new Amount(value): Amount
Parameters
- value: BN
Returns Amount
Overrides AmountBase.constructor
- Defined in packages/shared/src/entities/amount.ts:57

Properties

`Private` `Readonly` #bn

#bn: BN

Accessors

bn

get bn(): BN
Returns BN
Inherited from AmountBase.bn
- Defined in packages/shared/src/entities/amount.ts:12

decimals

get decimals(): number
Returns number
Inherited from AmountBase.decimals
- Defined in packages/shared/src/entities/amount.ts:20

isZero

get isZero(): boolean
Returns boolean
Inherited from AmountBase.isZero
- Defined in packages/shared/src/entities/amount.ts:24

value

get value(): string
Returns string
Inherited from AmountBase.value
- Defined in packages/shared/src/entities/amount.ts:16

Methods

isGreaterThan

isGreaterThan(amount): boolean
Parameters
- amount: AmountBase
Returns boolean
Inherited from AmountBase.isGreaterThan
- Defined in packages/shared/src/entities/amount.ts:36

isGreaterThanOrEqualTo

isGreaterThanOrEqualTo(amount): boolean
Parameters
- amount: AmountBase
Returns boolean
Inherited from AmountBase.isGreaterThanOrEqualTo
- Defined in packages/shared/src/entities/amount.ts:40

isLessThan

isLessThan(amount): boolean
Parameters
- amount: AmountBase
Returns boolean
Inherited from AmountBase.isLessThan
- Defined in packages/shared/src/entities/amount.ts:28

isLessThanOrEqualTo

isLessThanOrEqualTo(amount): boolean
Parameters
- amount: AmountBase
Returns boolean
Inherited from AmountBase.isLessThanOrEqualTo
- Defined in packages/shared/src/entities/amount.ts:32

toJSON

toJSON(): {
decimals: number;
value: string;
}
Returns {
decimals: number;
value: string;
}
- decimals: number
- value: string
Inherited from AmountBase.toJSON
- Defined in packages/shared/src/entities/amount.ts:48

toString

toString(): string
Returns string
Inherited from AmountBase.toString
- Defined in packages/shared/src/entities/amount.ts:44

`Static` fromBN

fromBN(value): Amount
Parameters
- value: BN
Returns Amount
- Defined in packages/shared/src/entities/amount.ts:69

`Static` fromBigInt

fromBigInt(value, decimals): Amount
Parameters
- value: string
- decimals: number
Returns Amount
- Defined in packages/shared/src/entities/amount.ts:61

`Static` fromPlainObject

fromPlainObject(amount): Amount
Parameters
- amount: ClassInstanceToPlainObject<Amount>
Returns Amount
- Defined in packages/shared/src/entities/amount.ts:73

`Static` fromRaw

fromRaw(value, decimals): Amount
Parameters
- value: string
- decimals: number
Returns Amount
- Defined in packages/shared/src/entities/amount.ts:65

Generated using TypeDoc