DenominatedNumber

Hierarchy

• Number
  • DenominatedNumber

Index

Constructors

• constructor

Properties

• decimals
• denomination
• planck

Methods

• mapFromNumber
• mapFromPlanck
• toLocaleString
• toString
• valueOf
• fromNumber

Constructors

constructor

• new DenominatedNumber(planck: string | number | bigint | boolean, decimals: number, denomination?: string): DenominatedNumber

• Overrides Number.constructor

  Parameters

  • planck: string | number | bigint | boolean

  • decimals: number

  • optionaldenomination: string

  Returns DenominatedNumber

Properties

readonlydecimals

decimals: number

optionalreadonlydenomination

denomination?: string

readonlyplanck

planck: bigint

Methods

mapFromNumber

• mapFromNumber(mapper: (number: number) => number): DenominatedNumber

• Parameters

  • mapper: (number: number) => number

  Returns DenominatedNumber

mapFromPlanck

• mapFromPlanck(mapper: (planck: bigint) => bigint): DenominatedNumber

• Parameters

  • mapper: (planck: bigint) => bigint

  Returns DenominatedNumber

toLocaleString

• toLocaleString(locales?: string | string[], options?: NumberFormatOptions): string
• toLocaleString(locales?: LocalesArgument, options?: NumberFormatOptions): string

• Overrides Number.toLocaleString

  Parameters

  • optionallocales: string | string[]

  • optionaloptions: NumberFormatOptions

  Returns string

toString

• toString(): string

• Overrides Number.toString

  Returns string

valueOf

• valueOf(): number

• Overrides Number.valueOf

  Returns number

staticfromNumber

• fromNumber(number: string | number, decimals: number, denomination?: string): DenominatedNumber

• Parameters

  • number: string | number

  • decimals: number

  • optionaldenomination: string

  Returns DenominatedNumber