Skip to Content

NumberUnit

class

NumberUnit

Constructor

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

Parameters:

numberLike: NumberLike
unit: Unit

Returns:

NumberUnit

Properties

_number
BigIntWrapper
baseUnit
defaultUnit
unit
unitName
string
unitType
isNumberUnit
any

Methods

abs
abs(): NumberUnit

Returns:

NumberUnit
add

Parameters:

Returns:

NumberUnit
cast
cast(unitType: UnitType): NumberUnit

Parameters:

unitType: UnitType

Returns:

NumberUnit
ceil
ceil(): NumberUnit

Returns:

NumberUnit
clampLowerZero
clampLowerZero(): NumberUnit

Returns:

NumberUnit
clone
clone(): NumberUnit

Returns:

NumberUnit
div

Parameters:

Returns:

NumberUnit
equals
equals(num: NumberUnit): boolean

Parameters:

Returns:

boolean
floor
floor(): NumberUnit

Returns:

NumberUnit
gt
gt(num: NumberUnit): boolean

Parameters:

Returns:

boolean
gte
gte(num: NumberUnit): boolean

Parameters:

Returns:

boolean
lt
lt(num: NumberUnit): boolean

Parameters:

Returns:

boolean
lte
lte(num: NumberUnit): boolean

Parameters:

Returns:

boolean
mul

Parameters:

Returns:

NumberUnit
negate
negate(): NumberUnit

Returns:

NumberUnit
round
round(): NumberUnit

Returns:

NumberUnit
sub

Parameters:

Returns:

NumberUnit
to

Parameters:

unit: ToUnitArg
conversionUnit (optional): ConversionUnitFn | ConversionUnitObject

Returns:

NumberUnit
toBase
toBase(): NumberUnit

Returns:

NumberUnit
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:

NumberUnit
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:

NumberUnit
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:

unit: Unit

Returns:

NumberUnit
isInstance
isInstance(instance: unknown): boolean

Parameters:

instance: unknown

Returns:

boolean

Accessors

isNegative
isPositive
isZero
value
Exodus:CurrencyId

Start building

XO

Request Demo

Schedule a call with our team

Select a product
Arrow right

Start building
Grateful

Contact Us

We're here to help