48 lines
1.5 KiB
JavaScript
48 lines
1.5 KiB
JavaScript
|
import { constructFrom } from "./constructFrom.js";
|
||
|
import { getDaysInMonth } from "./getDaysInMonth.js";
|
||
|
import { toDate } from "./toDate.js";
|
||
|
|
||
|
/**
|
||
|
* The {@link setMonth} function options.
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* @name setMonth
|
||
|
* @category Month Helpers
|
||
|
* @summary Set the month to the given date.
|
||
|
*
|
||
|
* @description
|
||
|
* Set the month to the given date.
|
||
|
*
|
||
|
* @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 date to be changed
|
||
|
* @param month - The month index to set (0-11)
|
||
|
* @param options - The options
|
||
|
*
|
||
|
* @returns The new date with the month set
|
||
|
*
|
||
|
* @example
|
||
|
* // Set February to 1 September 2014:
|
||
|
* const result = setMonth(new Date(2014, 8, 1), 1)
|
||
|
* //=> Sat Feb 01 2014 00:00:00
|
||
|
*/
|
||
|
export function setMonth(date, month, options) {
|
||
|
const _date = toDate(date, options?.in);
|
||
|
const year = _date.getFullYear();
|
||
|
const day = _date.getDate();
|
||
|
|
||
|
const midMonth = constructFrom(options?.in || date, 0);
|
||
|
midMonth.setFullYear(year, month, 15);
|
||
|
midMonth.setHours(0, 0, 0, 0);
|
||
|
const daysInMonth = getDaysInMonth(midMonth);
|
||
|
|
||
|
// Set the earlier date, allows to wrap Jan 31 to Feb 28
|
||
|
_date.setMonth(month, Math.min(day, daysInMonth));
|
||
|
return _date;
|
||
|
}
|
||
|
|
||
|
// Fallback for modularized imports:
|
||
|
export default setMonth;
|