formatters.ts

import { differenceInMilliseconds, format } from 'date-fns';

export interface IFormatValidationResult {
  isValid: boolean;
  message?: string;
}
/**
 * Checks if a given date format string is valid.
 *
 * This function checks if the input date format string is valid.
 *
 * @param {string} dateFormat - The date format string to validate.
 * @returns {IFormatValidationResult} Returns validation result.
 */
export const validateDateFormat = (
  dateFormat: string
): IFormatValidationResult => {
  const testDate = new Date();
  try {
    format(testDate, dateFormat);
    return {
      isValid: true,
    };
  } catch (error) {
    return {
      isValid: false,
      message: (error as Error).message,
    };
  }
};

export const getTimeString = (
  date: Date,
  dateFormat = 'yyy-MM-dd HH:mm:ss'
): string => {
  return format(date, dateFormat);
};

export const getTimeDiff = (end: Date, start: Date): string => {
  // Human format based on loosely on ideas from:
  // https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/src/jupyter_contrib_nbextensions/nbextensions/execute_time/ExecuteTime.js#L194
  const MS_IN_SEC = 1000;
  const MS_IN_MIN = 60 * MS_IN_SEC;
  const MS_IN_HR = 60 * MS_IN_MIN;
  const MS_IN_DAY = 24 * MS_IN_HR;

  let ms = differenceInMilliseconds(end, start);
  if (ms < MS_IN_SEC) {
    return `${ms}ms`;
  }
  const days = Math.floor(ms / MS_IN_DAY);
  ms = ms % MS_IN_DAY;

  const hours = Math.floor(ms / MS_IN_HR);
  ms = ms % MS_IN_HR;

  const mins = Math.floor(ms / MS_IN_MIN);
  ms = ms % MS_IN_MIN;

  // We want to show this as fractional
  const secs = ms / MS_IN_SEC;

  let timeDiff = '';
  if (days) {
    timeDiff += `${days}d `;
  }
  if (days || hours) {
    timeDiff += `${hours}h `;
  }
  if (days || hours || mins) {
    timeDiff += `${mins}m `;
  }
  // Only show s if its < 1 day
  if (!days) {
    // Only show ms if is < 1 hr
    timeDiff += `${secs.toFixed(hours ? 0 : 2)}s`;
  }
  return timeDiff.trim();
};