📝 Commit Details:
This commit is contained in:
40
backend/node_modules/date-fns/eachWeekendOfYear.d.ts
generated
vendored
Normal file
40
backend/node_modules/date-fns/eachWeekendOfYear.d.ts
generated
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
import type { ContextOptions, DateArg } from "./types.js";
|
||||
/**
|
||||
* The {@link eachWeekendOfYear} function options.
|
||||
*/
|
||||
export interface EachWeekendOfYearOptions<DateType extends Date = Date>
|
||||
extends ContextOptions<DateType> {}
|
||||
/**
|
||||
* @name eachWeekendOfYear
|
||||
* @category Year Helpers
|
||||
* @summary List all the Saturdays and Sundays in the year.
|
||||
*
|
||||
* @description
|
||||
* Get all the Saturdays and Sundays in the year.
|
||||
*
|
||||
* @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 given year
|
||||
* @param options - An object with options
|
||||
*
|
||||
* @returns An array containing all the Saturdays and Sundays
|
||||
*
|
||||
* @example
|
||||
* // Lists all Saturdays and Sundays in the year
|
||||
* const result = eachWeekendOfYear(new Date(2020, 1, 1))
|
||||
* //=> [
|
||||
* // Sat Jan 03 2020 00:00:00,
|
||||
* // Sun Jan 04 2020 00:00:00,
|
||||
* // ...
|
||||
* // Sun Dec 27 2020 00:00:00
|
||||
* // ]
|
||||
* ]
|
||||
*/
|
||||
export declare function eachWeekendOfYear<
|
||||
DateType extends Date,
|
||||
ResultDate extends Date = DateType,
|
||||
>(
|
||||
date: DateArg<DateType>,
|
||||
options?: EachWeekendOfYearOptions<ResultDate>,
|
||||
): ResultDate[];
|
Reference in New Issue
Block a user