1234567891011121314151617181920212223242526272829303132333435363738 |
- import { toDate } from "./toDate.js";
- /**
- * The {@link startOfMonth} function options.
- */
- /**
- * @name startOfMonth
- * @category Month Helpers
- * @summary Return the start of a month for the given date.
- *
- * @description
- * Return the start of a month 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).
- * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed,
- * or inferred from the arguments.
- *
- * @param date - The original date
- * @param options - An object with options
- *
- * @returns The start of a month
- *
- * @example
- * // The start of a month for 2 September 2014 11:55:00:
- * const result = startOfMonth(new Date(2014, 8, 2, 11, 55, 0))
- * //=> Mon Sep 01 2014 00:00:00
- */
- export function startOfMonth(date, options) {
- const _date = toDate(date, options?.in);
- _date.setDate(1);
- _date.setHours(0, 0, 0, 0);
- return _date;
- }
- // Fallback for modularized imports:
- export default startOfMonth;
|