date-fns-jalali/startOfQuarter.mjs

Modern JavaScript date utility library for jalali calendar

import { toDate } from "./toDate.mjs";
import { getMonth as coreGetMonth } from "./_core/getMonth.mjs";
import { setMonth as coreSetMonth } from "./_core/setMonth.mjs";

/**
 * @name startOfQuarter
 * @category Quarter Helpers
 * @summary Return the start of a year quarter for the given date.
 *
 * @description
 * Return the start of a year quarter for the given date.
 * The result will be in the local timezone.
 *
 * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
 *
 * @param date - The original date
 *
 * @returns The start of a quarter
 *
 * @example
 * // The start of a quarter for 2 September 2014 11:55:00:
 * const result = startOfQuarter(new Date(2014, 8, 2, 11, 55, 0))
 * //=> Tue Jul 01 2014 00:00:00
 */
export function startOfQuarter(date) {
  const _date = toDate(date);
  const currentMonth = coreGetMonth(_date);
  const month = currentMonth - (currentMonth % 3);
  coreSetMonth(_date, month, 1);
  _date.setHours(0, 0, 0, 0);
  return _date;
}

// Fallback for modularized imports:
export default startOfQuarter;