Class Hbar

Represents a quantity of hbar (ℏ), the native currency of the Hedera network. Provides utilities for handling different hbar denominations and conversions.

Index

Constructors

Properties

_valueInTinybar

Methods

isNegative negated to toBigNumber toString toTinybars from fromString fromTinybars

Constructors

constructor

new Hbar(
amount: string | number | Long | BigNumber | LongObject,
unit?: undefined | HbarUnit,
): Hbar
Parameters
- amount: string | number | Long | BigNumber | LongObject
- unit: undefined | HbarUnit = HbarUnit.Hbar
Returns Hbar
- Defined in src/Hbar.js:22

Properties

_valueInTinybar

_valueInTinybar: BigNumber

Methods

isNegative

isNegative(): boolean
Returns boolean
- Defined in src/Hbar.js:121

negated

negated(): Hbar
Returns Hbar
- Defined in src/Hbar.js:114

to

to(unit: HbarUnit): BigNumber
Parameters
- unit: HbarUnit
Returns BigNumber
- Defined in src/Hbar.js:93

toBigNumber

toBigNumber(): BigNumber
Returns BigNumber
- Defined in src/Hbar.js:100

toString

toString(unit: undefined | HbarUnit): string
Parameters
- unit: undefined | HbarUnit
Returns string
- Defined in src/Hbar.js:129

toTinybars

toTinybars(): Long
Returns Long
- Defined in src/Hbar.js:107

`Static`from

from(amount: string | number | Long | BigNumber, unit: HbarUnit): Hbar
Parameters
- amount: string | number | Long | BigNumber
- unit: HbarUnit
Returns Hbar
- Defined in src/Hbar.js:56

`Static`fromString

fromString(str: string, unit?: undefined | HbarUnit): Hbar
Parameters
- str: string
- unit: undefined | HbarUnit = HbarUnit.Hbar
Returns Hbar
- Defined in src/Hbar.js:76

`Static`fromTinybars

fromTinybars(amount: string | number | Long | BigNumber): Hbar
Parameters
- amount: string | number | Long | BigNumber
Returns Hbar
- Defined in src/Hbar.js:64