timepiece/node_modules/date-fns/setDate.mjs

31 lines
897 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { toDate } from "./toDate.mjs";
/**
* @name setDate
* @category Day Helpers
* @summary Set the day of the month to the given date.
*
* @description
* Set the day of 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).
*
* @param date - The date to be changed
* @param dayOfMonth - The day of the month of the new date
*
* @returns The new date with the day of the month set
*
* @example
* // Set the 30th day of the month to 1 September 2014:
* const result = setDate(new Date(2014, 8, 1), 30)
* //=> Tue Sep 30 2014 00:00:00
*/
export function setDate(date, dayOfMonth) {
const _date = toDate(date);
_date.setDate(dayOfMonth);
return _date;
}
// Fallback for modularized imports:
export default setDate;