DefinitelyTyped/bytes/bytes.d.ts

// Type definitions for bytes v2.1.0
// Project: https://github.com/visionmedia/bytes.js
// Definitions by: Zhiyuan Wang <https://github.com/danny8002/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

declare module 'bytes' {

    interface IBytesFormatOptions {
        thousandsSeparator: string
    }

    /**
     *Convert the given value in bytes into a string.
     *
     * @param {number} value
     * @param {{
     *  thousandsSeparator: [string]
     *  }} [options] bytes options.
     *
     * @returns {string}
     */
    function bytes(value: number, options?: IBytesFormatOptions): string;

    /**
     *Parse string to an integer in bytes.
     *
     * @param {string} value
     * @returns {number}
     */
    function bytes(value: string): number;

    module bytes {

        /**
         * Format the given value in bytes into a string.
         * 
         * If the value is negative, take Math.abs(). If it is a float,
         * it is rounded.
         * 
         * @param {number} value
         * @param {IBytesFormatOptions} [options]
         */

        function format(value: number, options?: IBytesFormatOptions): string;

        /**
         * Just return the input number value.
         * 
         * @param {number} value
         * @return {number}
         */
        function parse(value: number): number;

        /**
         * Parse the string value into an integer in bytes.
         * 
         * If no unit is given, it is assumed the value is in bytes.
         * 
         * @param {string} value
         * @return {number}
         */
        function parse(value: string): number;
    }

    export = bytes;
}