terriajs/lib/ReactViews/BottomDock/Timeline/DateFormats.ts

Geospatial data visualization platform.

import defined from "terriajs-cesium/Source/Core/defined";

/**
 * Formats a date according to the locale if provided, otherwise in a dd/mm/yyyy format.
 *
 * @param d the date to format
 * @param locale the locale to use for formatting
 * @returns A formatted date.
 */
export function formatDate(d: Date, locale?: string): string {
  if (defined(locale)) {
    return d.toLocaleDateString(locale);
  }
  return [pad(d.getDate()), pad(d.getMonth() + 1), d.getFullYear()].join("/");
}

/**
 * Formats the time according to the locale if provided, otherwise in a hh:mm:ss format.
 *
 * @param d the date to format
 * @param locale the locale to use for formatting
 * @returns A formatted time.
 */
export function formatTime(d: Date, locale?: string): string {
  if (defined(locale)) {
    return d.toLocaleTimeString(locale);
  }
  return [pad(d.getHours()), pad(d.getMinutes()), pad(d.getSeconds())].join(
    ":"
  );
}

/**
 * Combines {@link #formatDate} and {@link #formatTime}.
 *
 * @param d the date to format
 * @param locale the locale to use for formatting
 * @returns A formatted date and time with a comma separating them.
 */
export function formatDateTime(d: Date, locale?: string): string {
  return formatDate(d, locale) + ", " + formatTime(d, locale);
}

/**
 * Puts a leading 0 in front of a number of it's less than 10.
 *
 * @param s A number to pad
 * @returns A string representing a two-digit number.
 */
function pad(s: number): string {
  return s < 10 ? "0" + s : `${s}`;
}