@janiscommerce/app-dates/lib/helpers/formatSingleDate.js

Dates helper

import formatDate from './formatDate.js';
import isToday from './isToday.js';
import isTomorrow from './isTomorrow.js';

/**
 * The `formatSingleDate` function formats a single date using a specified format or a default format
 * based on locale settings.
 * @param {string} date - The `date` parameter is the date that you want to format.
 * should be displayed. It can include placeholders for different parts of the date, such as year,
 * month, day, etc. For example, "MM/DD/YYYY" or "DD MMMM YYYY". If no format is
 * @param options - The `options` parameter likely contains additional settings or configurations that
 * can be passed to the `formatSingleDate` function. These settings could include things like the
 * locale to use for formatting the date, any specific date format to apply, or other customization
 * options.
 * @returns The `formatSingleDate` function is returning the result of calling the `formatDate`
 * function with the `date`, `formatToUse`, and `options` as arguments.
 */
export default (date, options) => {
	if (isToday(date))
		return formatDate(
			date,
			`'Until' 'today', ${options?.locale?.customFormat?.hours} 'hours'`,
			options
		);

	if (isTomorrow(date))
		return formatDate(
			date,
			`'Until' 'tomorrow', ${options?.locale?.customFormat?.hours} 'hours'`,
			options
		);

	return formatDate(date, `'Until' ${options?.locale?.customFormat?.singleDate} 'hours'`, options);
};