@exodus/currency

CreateFromBaseValueParams

Interfaces

BNLike

ConversionUnitObject

CreateFromBaseValueParams

BNLike

Legacy bn.js-shaped value. `@exodus/currency` historically accepted these in the `Unit` factory (the constructor's `isMaybeBN` branch handles them, throwing for non-base units and accepting for `baseUnit`). New code should pass `bigint`, `BigIntWrapper`, `string`, or `number` instead.

ConversionUnitObject

`UnitType.create({ a: 0, b: 8 })` returns `UnitType & { a: Unit; b: Unit }`, exposing the runtime-attached unit properties (the deprecated indexed-name access path) to TS consumers. Use `.units[name]` instead.

Functions

Type Aliases

Variables

createFromBaseValue

NumberUnit

class

Constructor

constructor

NumberUnit(numberLike: NumberLike, unit: Unit): NumberUnit

Parameters:

numberLike: NumberLike

unit: Unit

Returns:

Properties

_number

baseUnit

defaultUnit

unit

unitName

string

unitType

isNumberUnit

any

Methods

abs

abs(): NumberUnit

Returns:

add

add(num: NumberLike | NumberUnit): NumberUnit

Parameters:

Returns:

cast

cast(unitType: UnitType): NumberUnit

Parameters:

unitType: UnitType

Returns:

ceil

ceil(): NumberUnit

Returns:

clampLowerZero

clampLowerZero(): NumberUnit

Returns:

clone

clone(): NumberUnit

Returns:

div

div(num: NumberLike | NumberUnit): NumberUnit

Parameters:

Returns:

equals

equals(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

floor

floor(): NumberUnit

Returns:

gt(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

gte

gte(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

lt(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

lte

lte(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

mul

mul(num: NumberLike | NumberUnit): NumberUnit

Parameters:

Returns:

negate

negate(): NumberUnit

Returns:

round

round(): NumberUnit

Returns:

sub

sub(num: NumberLike | NumberUnit): NumberUnit

toBase

toBase(): NumberUnit

Returns:

toBaseBufferBE

toBaseBufferBE(length?: number): Buffer

Parameters:

length (optional): number

Returns:

Buffer

toBaseBufferLE

toBaseBufferLE(length?: number): Buffer

Parameters:

length (optional): number

Returns:

Buffer

toBaseNumber

toBaseNumber(): number

Returns:

number

toBaseString

toBaseString(__namedParameters?: any): string

Parameters:

__namedParameters (optional): any

Returns:

string

toDefault

toDefault(): NumberUnit

Returns:

toDefaultNumber

toDefaultNumber(): number

Returns:

number

toDefaultString

toDefaultString(__namedParameters?: any): string

Parameters:

__namedParameters (optional): any

Returns:

string

toFixed

toFixed(x: number, rm?: string): NumberUnit

Parameters:

x: number

rm (optional): string

Returns:

toJSON

toJSON(): any

Returns:

any

toNumber

toNumber(unit?: string | Unit): number

Parameters:

unit (optional): string | Unit

Returns:

number

toNumberString

toNumberString(unit?: string | Unit): string

Parameters:

unit (optional): string | Unit

Returns:

string

toString

toString(__namedParameters?: any): string

Parameters:

__namedParameters (optional): any

Returns:

string

valueOf

valueOf(): number

Returns:

number

[hasInstance]

[hasInstance](instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

create

create(num: NumberLike, unit: Unit): NumberUnit

Parameters:

num: NumberLike

unit: Unit

Returns:

isInstance

isInstance(instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

Accessors

isNegative

isPositive

isZero

value

Exodus:CurrencyId

UnitType

class

Constructor

constructor

UnitType(definitions: Definitions, initSymbol: symbol): UnitType

Parameters:

definitions: Definitions

initSymbol: symbol

Returns:

Properties

baseUnit

defaultUnit

units

UnitMap

create

any

isUnitType

any

Methods

equals

equals(other: UnitType): boolean

Parameters:

other: UnitType

Returns:

boolean

parse

parse(str: string): NumberUnit

Parameters:

str: string

Returns:

toJSON

toJSON(): Definitions

Returns:

Definitions

toString

toString(): string

Returns:

string

[hasInstance]

[hasInstance](instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

equals

equals(a: UnitType, b: UnitType): boolean

Parameters:

a: UnitType

b: UnitType

Returns:

boolean

isInstance

isInstance(instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

Accessors

ZERO

Exodus:UnitTypeId

CreateFromBaseValueParams

interface

Properties

power

number

symbol

string

value

NumberLike

UnitTypeWithUnits

type

createFromBaseValue

variable

Type

const createFromBaseValue: ({ value, symbol, power, }: CreateFromBaseValueParams) => NumberUnit

Signature

__type({ value, symbol, power, }: CreateFromBaseValueParams): NumberUnit

Parameters:

{ value, symbol, power, }: CreateFromBaseValueParams

Returns:

conversion

function

Signature

conversion(num1: NumberUnit, num2: NumberUnit): ConversionUnitFn

Parameters:

num1: NumberUnit

num2: NumberUnit

Returns:

conversionByRate

function

Signature

conversionByRate(ut1: UnitType, ut2: UnitType, rate: string | number, opts?: ConversionByRateOpts): ConversionUnitFn

Parameters:

ut1: UnitType

ut2: UnitType

rate: string | number

opts (optional): ConversionByRateOpts

Returns:

isNumberUnit

function

Signature

isNumberUnit(obj: unknown): any

Parameters:

obj: unknown

Returns:

any

BNLike

interface

Properties

constructor

any

words

number[]

Methods

toString

toString(): string

Returns:

string

ConversionUnitObject

interface

Properties

from

fromUnit?

string

fromValue

string | number

toUnit?

string

toValue

string | number

Unit

interface

Properties

multiplier

Wrapper

power

number

unitName

string

unitType

Methods

toJSON

toJSON(): any

Returns:

any

toString

toString(): string

Returns:

string

ConversionUnitFn

type

Definitions

type

NumberFraction

type

Properties

fraction

string

fractionLength

number

string

NumberLike

type

UnitMap

type

NumberUnit

class

Constructor

constructor

NumberUnit(numberLike: NumberLike, unit: Unit): NumberUnit

Parameters:

numberLike: NumberLike

unit: Unit

Returns:

Properties

_number

baseUnit

defaultUnit

unit

unitName

string

unitType

isNumberUnit

any

Methods

abs

abs(): NumberUnit

Returns:

add

add(num: NumberLike | NumberUnit): NumberUnit

Parameters:

Returns:

cast

cast(unitType: UnitType): NumberUnit

Parameters:

unitType: UnitType

Returns:

ceil

ceil(): NumberUnit

Returns:

clampLowerZero

clampLowerZero(): NumberUnit

Returns:

clone

clone(): NumberUnit

Returns:

div

div(num: NumberLike | NumberUnit): NumberUnit

Parameters:

Returns:

equals

equals(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

floor

floor(): NumberUnit

Returns:

gt(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

gte

gte(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

lt(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

lte

lte(num: NumberUnit): boolean

Parameters:

num: NumberUnit

Returns:

boolean

mul

mul(num: NumberLike | NumberUnit): NumberUnit

Parameters:

Returns:

negate

negate(): NumberUnit

Returns:

round

round(): NumberUnit

Returns:

sub

sub(num: NumberLike | NumberUnit): NumberUnit

Parameters:

Returns:

to(unit: ToUnitArg, conversionUnit?: ConversionUnitFn | ConversionUnitObject): NumberUnit

Parameters:

unit: ToUnitArg

conversionUnit (optional): ConversionUnitFn | ConversionUnitObject

Returns:

toBase

toBase(): NumberUnit

Returns:

toBaseBufferBE

toBaseBufferBE(length?: number): Buffer

Parameters:

length (optional): number

Returns:

Buffer

toBaseBufferLE

toBaseBufferLE(length?: number): Buffer

Parameters:

length (optional): number

Returns:

Buffer

toBaseNumber

toBaseNumber(): number

Returns:

number

toBaseString

toBaseString(__namedParameters: any): string

Parameters:

__namedParameters: any

Returns:

string

toDefault

toDefault(): NumberUnit

Returns:

toDefaultNumber

toDefaultNumber(): number

Returns:

number

toDefaultString

toDefaultString(__namedParameters: any): string

Parameters:

__namedParameters: any

Returns:

string

toFixed

toFixed(x: number, rm?: string): NumberUnit

Parameters:

x: number

rm (optional): string

Returns:

toJSON

toJSON(): any

Returns:

any

toNumber

toNumber(unit?: string | Unit): number

Parameters:

unit (optional): string | Unit

Returns:

number

toNumberString

toNumberString(unit?: string | Unit): string

Parameters:

unit (optional): string | Unit

Returns:

string

toString

toString(__namedParameters: any): string

Parameters:

__namedParameters: any

Returns:

string

valueOf

valueOf(): number

Returns:

number

[hasInstance]

[hasInstance](instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

create

create(num: NumberLike, unit: Unit): NumberUnit

Parameters:

num: NumberLike

unit: Unit

Returns:

isInstance

isInstance(instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

Accessors

isNegative

isPositive

isZero

value

Exodus:CurrencyId

UnitType

class

Constructor

constructor

UnitType(definitions: Definitions, initSymbol: symbol): UnitType

Parameters:

definitions: Definitions

initSymbol: symbol

Returns:

Properties

baseUnit

defaultUnit

units

UnitMap

create

any

isUnitType

any

Methods

equals

equals(other: UnitType): boolean

Parameters:

other: UnitType

Returns:

boolean

parse

parse(str: string): NumberUnit

Parameters:

str: string

Returns:

toJSON

toJSON(): Definitions

Returns:

Definitions

toString

toString(): string

Returns:

string

[hasInstance]

[hasInstance](instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

equals

equals(a: UnitType, b: UnitType): boolean

Parameters:

a: UnitType

b: UnitType

Returns:

boolean

isInstance

isInstance(instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

Accessors

ZERO

Exodus:UnitTypeId

CreateFromBaseValueParams

interface

Properties

power

number

symbol

string

value

NumberLike

UnitTypeWithUnits

type

conversion

function

Signature

conversion(num1: NumberUnit, num2: NumberUnit): ConversionUnitFn

Parameters:

num1: NumberUnit

num2: NumberUnit

Returns:

conversionByRate

function

Signature

conversionByRate(ut1: UnitType, ut2: UnitType, rate: string | number, opts: ConversionByRateOpts): ConversionUnitFn

Parameters:

ut1: UnitType

ut2: UnitType

rate: string | number

opts: ConversionByRateOpts

Returns:

createFromBaseValue

function

Signature

createFromBaseValue(__namedParameters: CreateFromBaseValueParams): NumberUnit

Parameters:

__namedParameters: CreateFromBaseValueParams

Returns:

isNumberUnit

function

Signature

isNumberUnit(obj: unknown): any

Parameters:

obj: unknown

Returns:

any

BNLike

interface

Properties

constructor

any

words

number[]

Methods

toString

toString(): string

Returns:

string

ConversionUnitObject

interface

Properties

from

fromUnit?

string

fromValue

string | number

toUnit?

string

toValue

string | number

Unit

interface

Properties

multiplier

Wrapper

power

number

unitName

string

unitType