Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
35 lines
1.2 KiB
Plaintext
35 lines
1.2 KiB
Plaintext
import { addMinutes } from "./addMinutes.js";
|
|
|
|
/**
|
|
* The {@link subMinutes} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name subMinutes
|
|
* @category Minute Helpers
|
|
* @summary Subtract the specified number of minutes from the given date.
|
|
*
|
|
* @description
|
|
* Subtract the specified number of minutes from 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 amount - The amount of minutes to be subtracted.
|
|
* @param options - An object with options
|
|
*
|
|
* @returns The new date with the minutes subtracted
|
|
*
|
|
* @example
|
|
* // Subtract 30 minutes from 10 July 2014 12:00:00:
|
|
* const result = subMinutes(new Date(2014, 6, 10, 12, 0), 30)
|
|
* //=> Thu Jul 10 2014 11:30:00
|
|
*/
|
|
export function subMinutes(date, amount, options) {
|
|
return addMinutes(date, -amount, options);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default subMinutes;
|