DMleadgen
46d973904b
Next.js website for Rocky Mountain Vending company featuring: - Product catalog with Stripe integration - Service areas and parts pages - Admin dashboard with Clerk authentication - SEO optimized pages with JSON-LD structured data Co-authored-by: Cursor <cursoragent@cursor.com>
41 lines
1.4 KiB
Text
41 lines
1.4 KiB
Text
import type { ContextOptions, DateArg, Day } from "./types.js";
|
|
/**
|
|
* The {@link previousDay} function options.
|
|
*/
|
|
export interface PreviousDayOptions<DateType extends Date = Date>
|
|
extends ContextOptions<DateType> {}
|
|
/**
|
|
* @name previousDay
|
|
* @category Weekday Helpers
|
|
* @summary When is the previous day of the week?
|
|
*
|
|
* @description
|
|
* When is the previous day of the week? 0-6 the day of the week, 0 represents Sunday.
|
|
*
|
|
* @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 check
|
|
* @param day - The day of the week
|
|
* @param options - An object with options
|
|
*
|
|
* @returns The date is the previous day of week
|
|
*
|
|
* @example
|
|
* // When is the previous Monday before Mar, 20, 2020?
|
|
* const result = previousDay(new Date(2020, 2, 20), 1)
|
|
* //=> Mon Mar 16 2020 00:00:00
|
|
*
|
|
* @example
|
|
* // When is the previous Tuesday before Mar, 21, 2020?
|
|
* const result = previousDay(new Date(2020, 2, 21), 2)
|
|
* //=> Tue Mar 17 2020 00:00:00
|
|
*/
|
|
export declare function previousDay<
|
|
DateType extends Date,
|
|
ResultDate extends Date = DateType,
|
|
>(
|
|
date: DateArg<DateType>,
|
|
day: Day,
|
|
options?: PreviousDayOptions<ResultDate> | undefined,
|
|
): ResultDate;
|