// Type definitions for Numeral.js
// Project: https://github.com/adamwdraper/Numeral-js
// Definitions by: Vincent Bortone <https://github.com/vbortone>
//                 Behind The Math <https://github.com/BehindTheMath>
//                 Kenneth Luján <https://github.com/klujanrosas>
//                   Carlos Quiroga <https://github.com/KarlosQ>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped


// http://numeraljs.com/#locales
interface NumeralJSLocale {
    delimiters: {
        thousands: string;
        decimal: string;
    };
    abbreviations: {
        thousand: string;
        million: string;
        billion: string;
        trillion: string;
    };
    ordinal(num: number): string;
    currency: {
        symbol: string;
    };
}

interface NumeralJSLocales {
    [id: string]: NumeralJSLocale
}

interface NumeralJSOptions {
    currentLocale: string;
    zeroFormat: string;
    nullFormat: string;
    defaultFormat: string;
    scalePercentBy100: boolean;
}

type RoundingFunction = (value: number) => number;

// http://numeraljs.com/#custom-formats
interface NumeralJsFormat {
    regexps: {
        format: RegExp,
        unformat: RegExp,
    },
    format: (value: any, format: string, roundingFunction: RoundingFunction) => string,
    unformat: (value: string) => number
}

type RegisterType = 'format' | 'locale';

// http://numeraljs.com/#use-it
interface Numeral {
    (value?: any): Numeral;
    version: string;
    isNumeral: boolean;
    options: NumeralJSOptions;

    /**
     * This function sets the current locale.  If no arguments are passed in,
     * it will simply return the current global locale key.
     */
    locale(key?: string): string;

    /**
     * Object with all loaded locales
     */
    locales: NumeralJSLocales;

    /**
     * This function provides access to the loaded locale data.  If
     * no arguments are passed in, it will simply return the current
     * global locale object.
     *
     * @param key Locale key, e.g 'es' for a spanish locale definition
     */
    localeData(key?: string): NumeralJSLocale;

    /**
     * This function resets the configuration to all the defaults
     */
    reset(): void;

    /**
     * Registers a language definition or a custom format definition.
     *
     * @param what Allowed values are: either 'format' or 'locale'
     * @param key The key of the registerd type, e.g. 'de' for a german locale definition
     * @param value The locale definition or the format definitiion
     */
    register(what: RegisterType, key: string, value: NumeralJSLocale | NumeralJsFormat): NumeralJSLocale | NumeralJsFormat;

    zeroFormat(format: string): void;
    nullFormat(format: string): void;
    defaultFormat(format: string): void;
    clone(): Numeral;
    format(inputString?: string, roundingFunction?: RoundingFunction): string;
    unformat(inputString: string): number;
    value(): number;
    valueOf(): number;
    set(value: any): Numeral;
    add(value: any): Numeral;
    subtract(value: any): Numeral;
    multiply(value: any): Numeral;
    divide(value: any): Numeral;
    difference(value: any): number;
    validate(value: any, culture: any): boolean;
}

declare var numeral: Numeral;

/**
 * Usage: <code>import * as numeral from 'numeral'</code>
 */
declare module "numeral" {

    export = numeral;

}