typescript-closure-tools/index/closure-library/closure/goog/i18n/currency.d.ts

Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files

/// <reference path="../../../globals.d.ts" />

declare module goog.i18n.currency {

    /**
     * This function will add tier2 currency support. Be default, only tier1
     * (most popular currencies) are supported. If an application really needs
     * to support some of the rarely used currencies, it should call this function
     * before any other functions in this namespace.
     */
    function addTier2Support(): void;

    /**
     * Global currency pattern always uses ISO-4217 currency code as prefix. Local
     * currency sign is added if it is different from currency code. Each currency
     * is unique in this form. The negative side is that ISO code looks weird in
     * some countries as people normally do not use it. Local currency sign
     * alleviates the problem, but also makes it a little verbose.
     *
     * @param {string} currencyCode ISO-4217 3-letter currency code.
     * @return {string} Global currency pattern string for given currency.
     */
    function getGlobalCurrencyPattern(currencyCode: string): string;

    /**
     * Return global currency sign string for those applications
     * that want to handle currency sign themselves.
     *
     * @param {string} currencyCode ISO-4217 3-letter currency code.
     * @return {string} Global currency sign for given currency.
     */
    function getGlobalCurrencySign(currencyCode: string): string;

    /**
     * Local currency pattern is the most frequently used pattern in currency's
     * native region. It does not care about how it is distinguished from other
     * currencies.
     *
     * @param {string} currencyCode ISO-4217 3-letter currency code.
     * @return {string} Local currency pattern string for given currency.
     */
    function getLocalCurrencyPattern(currencyCode: string): string;

    /**
     * Returns local currency sign string for those applications that need to
     * handle currency sign separately.
     *
     * @param {string} currencyCode ISO-4217 3-letter currency code.
     * @return {string} Local currency sign for given currency.
     */
    function getLocalCurrencySign(currencyCode: string): string;

    /**
     * Portable currency pattern is a compromise between local and global. It is
     * not a mere blend or mid-way between the two. Currency sign is chosen so that
     * it looks familiar to native users. It also has enough information to
     * distinguish itself from other popular currencies in its native region.
     * In this pattern, currency sign symbols that has availability problem in
     * popular fonts are also avoided.
     *
     * @param {string} currencyCode ISO-4217 3-letter currency code.
     * @return {string} Portable currency pattern string for given currency.
     */
    function getPortableCurrencyPattern(currencyCode: string): string;

    /**
     * Return portable currency sign string for those applications that need to
     * handle currency sign themselves.
     *
     * @param {string} currencyCode ISO-4217 3-letter currency code.
     * @return {string} Portable currency sign for given currency.
     */
    function getPortableCurrencySign(currencyCode: string): string;

    /**
     * This function returns the default currency sign position. Some applications
     * may want to handle currency sign and currency amount separately. This
     * function can be used in such situations to correctly position the currency
     * sign relative to the amount.
     *
     * To match the behavior of ICU, position is not determined by display locale.
     *
     * @param {string} currencyCode ISO-4217 3-letter currency code.
     * @return {boolean} true if currency should be positioned before amount field.
     */
    function isPrefixSignPosition(currencyCode: string): boolean;

    /**
     * Modify currency pattern string by adjusting precision for given currency.
     * Standard currency pattern will have 2 digit after decimal point.
     * Examples:
     *   $#,##0.00 ->  $#,##0    (precision == 0)
     *   $#,##0.00 ->  $#,##0.0  (precision == 1)
     *   $#,##0.00 ->  $#,##0.000  (precision == 3)
     *
     * @param {string} pattern currency pattern string.
     * @param {string} currencyCode 3-letter currency code.
     * @return {string} modified currency pattern string.
     */
    function adjustPrecision(pattern: string, currencyCode: string): string;

    /**
     * Tier 1 currency information.
     *
     * The first number in the array is a combination of the precision mask and
     * other flags. The precision mask indicates how many decimal places to show for
     * the currency. Valid values are [0..7]. The position flag indicates whether
     * the currency sign should be positioned after the number. Valid values are 0
     * (before the number) or 16 (after the number). The space flag indicates
     * whether a space should be inserted between the currency sign and number.
     * Valid values are 0 (no space) and 32 (space).
     *
     * The number in the array is calculated by adding together the mask and flag
     * values. For example:
     *
     * 0: no precision (0), currency sign first (0), no space (0)
     * 2: two decimals precision (2), currency sign first (0), no space (0)
     * 18: two decimals precision (2), currency sign last (16), no space (0)
     * 50: two decimals precision (2), currency sign last (16), space (32)
     *
     * @type {!Object.<!Array>}
     */
    var CurrencyInfo: { [key: string]: any /*missing*/ };

    /**
     * Tier 2 currency information.
     * @type {!Object.<!Array>}
     */
    var CurrencyInfoTier2: { [key: string]: any /*missing*/ };
}