37 lines
1.1 KiB
JavaScript
37 lines
1.1 KiB
JavaScript
|
import { toDate } from "./toDate.js";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link setMinutes} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name setMinutes
|
||
|
|
* @category Minute Helpers
|
||
|
|
* @summary Set the minutes to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Set the minutes to the given date.
|
||
|
|
*
|
||
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows using extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
||
|
|
* @typeParam ResultDate - The result `Date` type, returned from the context function, or inferred from the arguments.
|
||
|
|
*
|
||
|
|
* @param date - The date to be changed
|
||
|
|
* @param minutes - The minutes of the new date
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The new date with the minutes set
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Set 45 minutes to 1 September 2014 11:30:40:
|
||
|
|
* const result = setMinutes(new Date(2014, 8, 1, 11, 30, 40), 45)
|
||
|
|
* //=> Mon Sep 01 2014 11:45:40
|
||
|
|
*/
|
||
|
|
export function setMinutes(date, minutes, options) {
|
||
|
|
const date_ = toDate(date, options?.in);
|
||
|
|
date_.setMinutes(minutes);
|
||
|
|
return date_;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default setMinutes;
|