@js-data-tools/js-helpers/dist/types/format.d.ts

A set of JavaScript / TypeScript helper functions for parsing, converting, transforming and formatting data.

export declare const SI_SIZE_UNITS: string[];
export declare const IEC_SIZE_UNITS: string[];
export declare const NUMERIC_UNITS: string[];
/**
 * Formats a given size (in bytes) as a compact string with units suffix (12345678790 => 1.23 GB).
 *
 * @since 0.1.2
 * @category format
 * @param {number} sizeInBytes - The size (in bytes) to format.
 * @param {number} [base=1000] - The base to use when compacting size.  Can be either 1000 (SI) or 1024 (IEC).
 * @param {string[]} [unitNames] - An optional list of unit names to use. If this parameter is omitted, this function will
 * automatically use the {@link SI_SIZE_UNITS} (if the base is 1000) or the {@link IEC_SIZE_UNITS}  (if the base is 1024).
 * @returns {string} A string with a compact version of size (1.27GB)
 *
 * @example
 *
 * console.log(formatSize(1023456789));       // => 1.02 GB
 * console.log(formatSize(1023456789, 1024)); // => 976 MiB
 *
 */
export declare function formatSize(sizeInBytes: number, base?: 1000 | 1024, unitNames?: string[]): string;
/**
 * Formats a numeric value, using a compact form (aka "1.2M"), which usually takes not more than 6 symbols.
 *
 * @since 0.1.2
 * @category format
 * @param {number} value - The numerical value to format in a compact form.
 * @returns {string} A compact form of the given number (usually up to 5 characters).
 *
 * @example
 *
 * console.log(formatCompact(123)); // => 123
 * console.log(formatCompact(1200345)); // => 1.2M
 *
 */
export declare function formatCompact(value: number): string;
/**
 * Format a duration of operation, initially measured in milliseconds.
 *
 * @description When the duration is shorter than one second, the result will be measured in milliseconds (integer).
 * If duration is in the range between 1 second and 1 minute, it will be measured in seconds (up to two decimal digits).
 * Durations between one and two minutes will be measured in seconds (as an integer number)
 * And finally, the duration longer than 2 minutes will be presented as "M min [S sec]".
 *
 * @since 0.2.0
 * @category format
 * @param {number} durationMsec - The duration (in milliseconds) to format
 * @returns A string, representing given duration in milliseconds or seconds (whatever is shorter)
 *
 * @example
 *
 * formatDuration(925);       // 925 msec
 * formatDuration(53256);     // 53.26 sec
 * formatDuration(65256);     // 65 sec
 * formatDuration(127874);    // 2 min 8 sec
 * formatDuration(180014);    // 3 min
 *
 */
export declare function formatDuration(durationMsec: number): string;