Class Balance<T>

Type Parameters

T extends BaseCurrencyType

Hierarchy

Balance

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Balance<T>(integerBalance: undefined | number, type: T): Balance<T>

- Defined in currency/src/Balance.ts:56
Type Parameters
- T extends default<T>
Parameters
- integerBalance: undefined | number
- type: T
Returns Balance<T>

Properties

bigBalance

bigBalance: BigNumber

bigInteger

bigInteger: BigNumber

floatBalance

floatBalance: number

integerBalance

integerBalance: number

type

type: T

Methods

dividedBy

dividedBy(n: number): Balance<T>

- Defined in currency/src/Balance.ts:125
Parameters
- n: number
Returns Balance<T>

minus

minus(balance: Balance<T>): Balance<T>

- Defined in currency/src/Balance.ts:116
Parameters
- balance: Balance<T>
Returns Balance<T>

plus

plus(balance: Balance<T>): Balance<T>

- Defined in currency/src/Balance.ts:111
Parameters
- balance: Balance<T>
Returns Balance<T>

times

times(n: number): Balance<T>

- Defined in currency/src/Balance.ts:121
Parameters
- n: number
Returns Balance<T>

toDataCredits

toDataCredits(oraclePrice?: Balance<USDollars>): Balance<DataCredits>

- Defined in currency/src/Balance.ts:196
Parameters
- Optional oraclePrice: Balance<USDollars>
Returns Balance<DataCredits>

toNetworkTokens

toNetworkTokens(oraclePrice?: Balance<USDollars>): Balance<NetworkTokens>

- Defined in currency/src/Balance.ts:129
Parameters
- Optional oraclePrice: Balance<USDollars>
Returns Balance<NetworkTokens>

toString

toString(maxDecimalPlaces?: number, options?: StringFormatOptions): string

- Defined in currency/src/Balance.ts:80
Parameters
- Optional maxDecimalPlaces: number
- Optional options: StringFormatOptions
Returns string

toTestNetworkTokens

toTestNetworkTokens(oraclePrice?: Balance<USDollars>): Balance<TestNetworkTokens>

- Defined in currency/src/Balance.ts:150
Parameters
- Optional oraclePrice: Balance<USDollars>
Returns Balance<TestNetworkTokens>

toUsd

toUsd(oraclePrice?: Balance<USDollars>): Balance<USDollars>

- Defined in currency/src/Balance.ts:171
Parameters
- Optional oraclePrice: Balance<USDollars>
Returns Balance<USDollars>

Static fromFloat

fromFloat(float: number, currencyType: AnyCurrencyType): Balance<AnyCurrencyType>

- Defined in currency/src/Balance.ts:64
Parameters
- float: number
- currencyType: AnyCurrencyType
Returns Balance<AnyCurrencyType>

Static fromFloatAndTicker

fromFloatAndTicker(float: number, ticker: Ticker): Balance<AnyCurrencyType>

- Defined in currency/src/Balance.ts:75
Parameters
- float: number
- ticker: Ticker
Returns Balance<AnyCurrencyType>

Static fromIntAndTicker

fromIntAndTicker(integerBalance: number, ticker?: "SOL" | "MOBILE" | "HNT" | "IOT" | "DC" | "TNT" | "USD" | "HST"): Balance<default>

- Defined in currency/src/Balance.ts:70
Parameters
- integerBalance: number
- Optional ticker: "SOL" | "MOBILE" | "HNT" | "IOT" | "DC" | "TNT" | "USD" | "HST"
Returns Balance<default>

Generated using TypeDoc