@barchart/common-js
Version:
Library of common JavaScript utilities
393 lines (392 loc) • 7.57 kB
TypeScript
/**
* An enumeration for currency types.
*
* @public
* @extends {Enum}
*/
export default class Currency extends Enum {
/**
* Given a code, returns the enumeration item.
*
* @public
* @static
* @param {string} code
* @returns {Currency|null}
*/
public static parse(code: string): Currency | null;
/**
* The Argentine Peso.
*
* @public
* @static
* @returns {Currency}
*/
public static get ARS(): Currency;
/**
* The Australian Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get AUD(): Currency;
/**
* The Bermudian Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get BMD(): Currency;
/**
* The Brazilian Real.
*
* @public
* @static
* @returns {Currency}
*/
public static get BRL(): Currency;
/**
* The Bahamian Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get BSD(): Currency;
/**
* The Canadian Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get CAD(): Currency;
/**
* The Swiss Franc.
*
* @public
* @static
* @returns {Currency}
*/
public static get CHF(): Currency;
/**
* The Chinese Yuan.
*
* @public
* @static
* @returns {Currency}
*/
public static get CNY(): Currency;
/**
* The Czech Koruna.
*
* @public
* @static
* @returns {Currency}
*/
public static get CZK(): Currency;
/**
* The Danish Krone.
*
* @public
* @static
* @returns {Currency}
*/
public static get DKK(): Currency;
/**
* The Euro.
*
* @public
* @static
* @returns {Currency}
*/
public static get EUR(): Currency;
/**
* The Fijian Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get FJD(): Currency;
/**
* The British Pound.
*
* @public
* @static
* @returns {Currency}
*/
public static get GBP(): Currency;
/**
* The British Penny.
*
* @public
* @static
* @returns {Currency}
*/
public static get GBX(): Currency;
/**
* The Ghanaian Cedi.
*
* @public
* @static
* @returns {Currency}
*/
public static get GHS(): Currency;
/**
* The Hong Kong Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get HKD(): Currency;
/**
* The Hungarian Forint.
*
* @public
* @static
* @returns {Currency}
*/
public static get HUF(): Currency;
/**
* The Indonesian Rupiah.
*
* @public
* @static
* @returns {Currency}
*/
public static get IDR(): Currency;
/**
* The Israeli New Shekel.
*
* @public
* @static
* @returns {Currency}
*/
public static get ILS(): Currency;
/**
* The Jordanian Dinar.
*
* @public
* @static
* @returns {Currency}
*/
public static get JOD(): Currency;
/**
* The Japanese Yen.
*
* @public
* @static
* @returns {Currency}
*/
public static get JPY(): Currency;
/**
* The South Korean Won.
*
* @public
* @static
* @returns {Currency}
*/
public static get KRW(): Currency;
/**
* The Lebanese Pound.
*
* @public
* @static
* @returns {Currency}
*/
public static get LBP(): Currency;
/**
* The Mexican Peso.
*
* @public
* @static
* @returns {Currency}
*/
public static get MXN(): Currency;
/**
* The Malaysian Ringgit.
*
* @public
* @static
* @returns {Currency}
*/
public static get MYR(): Currency;
/**
* The Namibian Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get NAD(): Currency;
/**
* The Nigerian Naira.
*
* @public
* @static
* @returns {Currency}
*/
public static get NGN(): Currency;
/**
* The Norwegian Krone.
*
* @public
* @static
* @returns {Currency}
*/
public static get NOK(): Currency;
/**
* The New Zealand Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get NZD(): Currency;
/**
* The Peruvian Sol.
*
* @public
* @static
* @returns {Currency}
*/
public static get PEN(): Currency;
/**
* The Papua New Guinean Kina.
*
* @public
* @static
* @returns {Currency}
*/
public static get PGK(): Currency;
/**
* The Philippine peso.
*
* @public
* @static
* @returns {Currency}
*/
public static get PHP(): Currency;
/**
* The Polish Zloty.
*
* @public
* @static
* @returns {Currency}
*/
public static get PLN(): Currency;
/**
* The Russian Ruble.
*
* @public
* @static
* @returns {Currency}
*/
public static get RUB(): Currency;
/**
* The Russian Ruble (Old).
*
* @public
* @static
* @returns {Currency}
*/
public static get RUR(): Currency;
/**
* The Swedish Krona.
*
* @public
* @static
* @returns {Currency}
*/
public static get SEK(): Currency;
/**
* The Singapore Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get SGD(): Currency;
/**
* The Thai Baht.
*
* @public
* @static
* @returns {Currency}
*/
public static get THB(): Currency;
/**
* The Turkish Lira.
*
* @public
* @static
* @returns {Currency}
*/
public static get TRY(): Currency;
/**
* The New Taiwan Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get TWD(): Currency;
/**
* The US Dollar.
*
* @public
* @static
* @returns {Currency}
*/
public static get USD(): Currency;
/**
* The Uruguay Peso.
*
* @public
* @static
* @returns {Currency}
*/
public static get UYI(): Currency;
/**
* The South African Rand.
*
* @public
* @static
* @returns {Currency}
*/
public static get ZAR(): Currency;
/**
* The Zambian Kwacha.
*
* @public
* @static
* @returns {Currency}
*/
public static get ZMW(): Currency;
/**
* @param {string} code - Currency code (e.g. "USD")
* @param {string} description - The description (e.g. "US Dollar")
* @param {number} precision - The number of decimal places possible for by a real world transaction.
* @param {string=} alternateDescription
*/
constructor(code: string, description: string, precision: number, alternateDescription?: string | undefined);
/**
* The maximum number of decimal places supported by a real world transaction.
*
* @public
* @returns {number}
*/
public get precision(): number;
/**
* An alternate human-readable description.
*
* @public
* @returns {string}
*/
public get alternateDescription(): string;
#private;
}
import Enum from './Enum.js';