Class Asset

Class representing a hive asset, e.g. 1.000 HIVE or 12.112233 VESTS.

Hierarchy

Asset

Index

Constructors

Properties

Methods

add divide getPrecision multiply steem_symbols subtract toJSON toString from fromString max min

Constructors

constructor

new Asset(amount: number, symbol: AssetSymbol): Asset
Parameters
- amount: number
- symbol: AssetSymbol
Returns Asset
- Defined in chain/asset.ts:53

Properties

`Readonly` amount

amount: number

`Readonly` symbol

symbol: AssetSymbol

Methods

add

add(amount: string | number | Asset): Asset
Return a new Asset instance with amount added.
Parameters
- amount: string | number | Asset
Returns Asset
- Defined in chain/asset.ts:151

divide

divide(divisor: string | number | Asset): Asset
Return a new Asset with the amount divided.
Parameters
- divisor: string | number | Asset
Returns Asset
- Defined in chain/asset.ts:178

getPrecision

getPrecision(): number
Return asset precision.

Returns number
- Defined in chain/asset.ts:112

multiply

multiply(factor: string | number | Asset): Asset
Return a new Asset with the amount multiplied by factor.
Parameters
- factor: string | number | Asset
Returns Asset
- Defined in chain/asset.ts:169

steem_symbols

steem_symbols(): Asset
returns a representation of this asset using only STEEM SBD for legacy purposes

Returns Asset
- Defined in chain/asset.ts:130

subtract

subtract(amount: string | number | Asset): Asset
Return a new Asset instance with amount subtracted.
Parameters
- amount: string | number | Asset
Returns Asset
- Defined in chain/asset.ts:160

toJSON

toJSON(): string
For JSON serialization, same as toString().

Returns string
- Defined in chain/asset.ts:187

toString

toString(): string
Return a string representation of this asset, e.g. 42.000 HIVE.

Returns string
- Defined in chain/asset.ts:144

`Static` from

from(value: string | number | Asset, symbol?: AssetSymbol): Asset
Convenience to create new Asset.
Parameters
- value: string | number | Asset
- Optional symbol: AssetSymbol
  
  Symbol to use when created from number. Will also be used to validate the asset, throws if the passed value has a different symbol than this.
Returns Asset
- Defined in chain/asset.ts:78

`Static` fromString

fromString(string: string, expectedSymbol?: AssetSymbol): Asset
Create a new Asset instance from a string, e.g. 42.000 HIVE.
Parameters
- string: string
- Optional expectedSymbol: AssetSymbol
Returns Asset
- Defined in chain/asset.ts:58

`Static` max

max(a: Asset, b: Asset): Asset
Return the larger of the two assets.
Parameters
- a: Asset
- b: Asset
Returns Asset
- Defined in chain/asset.ts:104

`Static` min

min(a: Asset, b: Asset): Asset
Return the smaller of the two assets.
Parameters
- a: Asset
- b: Asset
Returns Asset
- Defined in chain/asset.ts:96

Generated using TypeDoc