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
34 lines
1.0 KiB
Plaintext
34 lines
1.0 KiB
Plaintext
import { previousDay } from "./previousDay.js";
|
|
|
|
/**
|
|
* The {@link previousSaturday} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name previousSaturday
|
|
* @category Weekday Helpers
|
|
* @summary When is the previous Saturday?
|
|
*
|
|
* @description
|
|
* When is the previous Saturday?
|
|
*
|
|
* @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 start counting from
|
|
* @param options - The options
|
|
*
|
|
* @returns The previous Saturday
|
|
*
|
|
* @example
|
|
* // When is the previous Saturday before Jun, 20, 2021?
|
|
* const result = previousSaturday(new Date(2021, 5, 20))
|
|
* //=> Sat June 19 2021 00:00:00
|
|
*/
|
|
export function previousSaturday(date, options) {
|
|
return previousDay(date, 6, options);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default previousSaturday;
|