SwapKitNumber

Defined in: packages/helpers/src/modules/swapKitNumber.ts:5

Extends

• BigIntArithmetics

Constructors

Constructor

new SwapKitNumber(params): SwapKitNumber

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:84

Parameters

params

SKBigIntParams

Returns

SwapKitNumber

Inherited from

BigIntArithmetics.constructor

Properties

bigIntValue

bigIntValue: bigint = 0n

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:59

Inherited from

BigIntArithmetics.bigIntValue

---

decimal?

optional decimal: number

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:60

Inherited from

BigIntArithmetics.decimal

---

decimalMultiplier

decimalMultiplier: bigint

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:58

Inherited from

BigIntArithmetics.decimalMultiplier

Methods

add()

add(…args): SwapKitNumber

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:106

Parameters

args

…InitialisationValueType[]

Returns

SwapKitNumber

Inherited from

BigIntArithmetics.add

---

div()

div(…args): SwapKitNumber

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:115

Parameters

args

…InitialisationValueType[]

Returns

SwapKitNumber

Inherited from

BigIntArithmetics.div

---

eq()

eq(value): boolean

Defined in: packages/helpers/src/modules/swapKitNumber.ts:6

Parameters

value

SwapKitValueType

Returns

boolean

---

eqValue()

eqValue(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:130

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.eqValue

---

formatBigIntToSafeValue()

formatBigIntToSafeValue(value, decimal?): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:267

Parameters

value

bigint

decimal?

number

Returns

string

Inherited from

BigIntArithmetics.formatBigIntToSafeValue

---

getBaseValue()

getBaseValue<T>(type, decimal?): NumberPrimitivesType[T]

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:153

Type Parameters

T

T extends AllowedNumberTypes

Parameters

type

T

decimal?

number

Returns

NumberPrimitivesType[T]

Inherited from

BigIntArithmetics.getBaseValue

---

getBigIntValue()

getBigIntValue(value, decimal?): bigint

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:170

Parameters

value

InitialisationValueType

decimal?

number

Returns

bigint

Inherited from

BigIntArithmetics.getBigIntValue

---

getValue()

getValue<T>(type, decimal?): NumberPrimitivesType[T]

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:134

Type Parameters

T

T extends AllowedNumberTypes

Parameters

type

T

decimal?

number

Returns

NumberPrimitivesType[T]

Inherited from

BigIntArithmetics.getValue

---

gt()

gt(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:118

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.gt

---

gte()

gte(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:121

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.gte

---

lt()

lt(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:124

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.lt

---

lte()

lte(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:127

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.lte

---

mul()

mul(…args): SwapKitNumber

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:112

Parameters

args

…InitialisationValueType[]

Returns

SwapKitNumber

Inherited from

BigIntArithmetics.mul

---

set()

set(value): this

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:97

Parameters

value

SKBigIntParams

Returns

this

Inherited from

BigIntArithmetics.set

---

sub()

sub(…args): SwapKitNumber

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:109

Parameters

args

…InitialisationValueType[]

Returns

SwapKitNumber

Inherited from

BigIntArithmetics.sub

---

toAbbreviation()

toAbbreviation(digits): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:228

Parameters

digits

number = 2

Returns

string

Inherited from

BigIntArithmetics.toAbbreviation

---

toCurrency()

toCurrency(currency, __namedParameters): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:242

Parameters

currency

string = "$"

__namedParameters

currencyPosition?

string = "start"

decimal?

number = 2

decimalSeparator?

string = "."

thousandSeparator?

string = ","

Returns

string

Inherited from

BigIntArithmetics.toCurrency

---

toFixed()

toFixed(fixedDigits): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:210

Parameters

fixedDigits

number = 6

Returns

string

Inherited from

BigIntArithmetics.toFixed

---

toSignificant()

toSignificant(significantDigits): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:180

Parameters

significantDigits

number = 6

Returns

string

Inherited from

BigIntArithmetics.toSignificant

---

fromBigInt()

static fromBigInt(value, decimal?): SwapKitNumber

Defined in: packages/helpers/src/modules/swapKitNumber.ts:10

Parameters

value

bigint

decimal?

number

Returns

SwapKitNumber

Overrides

BigIntArithmetics.fromBigInt

---

shiftDecimals()

static shiftDecimals(__namedParameters): BigIntArithmetics

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:69

Parameters

__namedParameters

from

number

to

number

value

SwapKitNumber

Returns

BigIntArithmetics

Inherited from

BigIntArithmetics.shiftDecimals