timesago/dist/types.d.ts

A simple & lightweight js library that make it easy to convert timestamps into human-readable time ago statements (eg. '2 hours ago' or 'in 3 days.')

export = timesago;
/**
 * Converts a timestamp to a human-readable "time ago" format.
 *
 * @param {string | number | Date}  time - The timestamp to convert
 * @param {Object} [options={}] - Additional options for customization.
 * @param {string | number | Date} [options.now=Date.now()] - The current timestamp.
 * @param {string} [options.prefixFromNow='in'] - The prefix for future timestamps.
 * @param {string} [options.suffixAgo='ago'] - The suffix for past timestamps.
 * @param {string} [options.justNow='just now'] - The label for timestamps within a minute.
 * @returns {string} - The formatted "time ago" string.
 *
 * @example
 * const result = timesago('December 12, 2021');
 * console.log(result); // 2 years ago
 *
 */
declare function timesago(time: string | number | Date, options?: {
    now?: string | number | Date;
    prefixFromNow?: string;
    suffixAgo?: string;
    justNow?: string;
}): string;
//# sourceMappingURL=types.d.ts.map