JSDoc: Class: Amount

Constructor

new Amount(valuenullable, unitnullable)

Create an amount.

Parameters:

Name	Type	Attributes	Description
`value`	String \| Number	<nullable>
`unit`	String	<nullable>

Properties:

Name	Type	Description
`value`	Amount

Source:

btc/amount.js, line 28

Methods

(static) btc(value) → {String}

Safely convert satoshis to a BTC string. This function explicitly avoids any floating point arithmetic.

Parameters:

Name	Type	Description
`value`	Amount	Satoshis.

Source:

btc/amount.js, line 312

Returns:

BTC string.

Type: String

(static) decode(value, exp) → {Amount}

Safely convert a BTC string to satoshis.

Parameters:

Name	Type	Description
`value`	String \| Number	BTC
`exp`	Number	Exponent.

Source:

btc/amount.js, line 355

Throws:

on parse error

Returns:

Satoshis.

Type: Amount

(static) encode(value, exp, num) → {String|Number}

Safely convert satoshis to a BTC string.

Parameters:

Name	Type	Description
`value`	Amount
`exp`	Number	Exponent.
`num`	Boolean	Return a number.

Source:

btc/amount.js, line 341

Returns:

Type: String | Number

(static) from(unit, value) → {Amount}

Instantiate amount from unit.

Parameters:

Name	Type	Description
`unit`	String
`value`	Number \| String

Source:

btc/amount.js, line 291

Returns:

Type: Amount

(static) fromBits(value) → {Amount}

Instantiate amount from bits.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 260

Returns:

Type: Amount

(static) fromBTC(value) → {Amount}

Instantiate amount from btc.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 280

Returns:

Type: Amount

(static) fromMBTC(value) → {Amount}

Instantiate amount from mbtc.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 270

Returns:

Type: Amount

(static) fromOptions(valuenullable, unitnullable) → {Amount}

Instantiate amount from options.

Parameters:

Name	Type	Attributes	Description
`value`	String \| Number	<nullable>
`unit`	String	<nullable>

Source:

btc/amount.js, line 229

Returns:

Type: Amount

(static) fromSatoshis(value) → {Amount}

Instantiate amount from satoshis.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 250

Returns:

Type: Amount

(private, static) fromValue(value) → {Amount}

Instantiate amount from value.

Parameters:

Name	Type	Description
`value`	Amount

Source:

btc/amount.js, line 240

Returns:

Type: Amount

(static) value(str) → {Amount}

Safely convert a BTC string to satoshis.

Parameters:

Name	Type	Description
`str`	String	BTC

Source:

btc/amount.js, line 326

Throws:

on parse error

Returns:

Satoshis.

Type: Amount

(private) from(unit, value) → {Amount}

Inject properties from unit.

Parameters:

Name	Type	Description
`unit`	String
`value`	Number \| String

Source:

btc/amount.js, line 207

Returns:

Type: Amount

(private) fromBits(value) → {Amount}

Inject properties from bits.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 170

Returns:

Type: Amount

(private) fromBTC(value) → {Amount}

Inject properties from btc.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 194

Returns:

Type: Amount

(private) fromMBTC(value) → {Amount}

Inject properties from mbtc.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 182

Returns:

Type: Amount

(private) fromOptions(valuenullable, unitnullable) → {Amount}

Inject properties from options.

Parameters:

Name	Type	Attributes	Description
`value`	String \| Number	<nullable>
`unit`	String	<nullable>

Source:

btc/amount.js, line 43

Returns:

Type: Amount

(private) fromSatoshis(value) → {Amount}

Inject properties from satoshis.

Parameters:

Name	Type	Description
`value`	Number \| String

Source:

btc/amount.js, line 158

Returns:

Type: Amount

(private) fromValue(value) → {Amount}

Inject properties from value.

Parameters:

Name	Type	Description
`value`	Amount

Source:

btc/amount.js, line 144

Returns:

Type: Amount

inspectSymbol() → {String}

Inspect amount.

Source:

btc/amount.js, line 300

Returns:

Type: String

to(unit, numnullable) → {String|Amount}

Get unit string or value.

Parameters:

Name	Type	Attributes	Description
`unit`	String		Can be `sat`, `ubtc`, `bits`, `mbtc`, or `btc`.
`num`	Boolean	<nullable>

Source:

btc/amount.js, line 113

Returns:

Type: String | Amount

toBits(numnullable) → {String|Amount}

Get bits string or value.

Parameters:

Name	Type	Attributes	Description
`num`	Boolean	<nullable>

Source:

btc/amount.js, line 81

Returns:

Type: String | Amount

toBTC(numnullable) → {String|Amount}

Get btc string or value.

Parameters:

Name	Type	Attributes	Description
`num`	Boolean	<nullable>

Source:

btc/amount.js, line 101

Returns:

Type: String | Amount

toMBTC(numnullable) → {String|Amount}

Get mbtc string or value.

Parameters:

Name	Type	Attributes	Description
`num`	Boolean	<nullable>

Source:

btc/amount.js, line 91

Returns:

Type: String | Amount

toSatoshis(numnullable) → {String|Amount}

Get satoshi string or value.

Parameters:

Name	Type	Attributes	Description
`num`	Boolean	<nullable>

Source:

btc/amount.js, line 68

Returns:

Type: String | Amount

toString() → {String}

Convert amount to bitcoin string.

Source:

btc/amount.js, line 133

Returns:

Type: String

toValue() → {Amount}

Get satoshi value.

Source:

btc/amount.js, line 58

Returns:

Type: Amount