readable-ms/index.d.ts

Converts a milliseconds value into a human-readable string.

/** @module readable-ms
 */
declare module "readable-ms" {
    /**
     * @function
     * @param {number} milliseconds
     * @returns {string} Formatted duration
     * @example
     * import readableMs from "readable-ms"
     * const result = readableMs(3021)
     * result === "3s 21ms"
     * const result2 = readableMs(0)
     * result2 === "0s"
     */
    export default function(milliseconds: number): string;
}