@barchart/common-js
Version:
Library of common JavaScript utilities
60 lines (59 loc) • 1.3 kB
TypeScript
/**
* A structure for storing money amounts.
*
* @public
*/
export default class Money {
/**
* Parses the value emitted by {@link Decimal#toJSON}.
*
* @public
* @static
* @param {object} value
* @returns {Money}
*/
public static parse(value: object): Money;
/**
* @param {Decimal|number|string} value - A amount, which can be parsed as a {@link Decimal}
* @param {Currency} currency - The currency.
*/
constructor(value: Decimal | number | string, currency: Currency);
/**
* The currency amount.
*
* @public
* @returns {Decimal}
*/
public get decimal(): Decimal;
/**
* The currency.
*
* @public
* @returns {Currency}
*/
public get currency(): Currency;
/**
* @public
* @param {*} places
* @param {*} mode
* @returns {Money}
*/
public toAmount(places: any, mode: any): Money;
/**
* Returns the JSON representation.
*
* @public
* @returns {object}
*/
public toJSON(): object;
/**
* Returns a string representation.
*
* @public
* @returns {string}
*/
public toString(): string;
#private;
}
import Decimal from './Decimal.js';
import Currency from './Currency.js';