FIN INIT

node_modules/date-fns/isWeekend.d.cts

@@ -0,0 +1,27 @@
+import type { ContextOptions, DateArg } from "./types.js";
+/**
+ * The {@link isWeekend} function options.
+ */
+export interface IsWeekendOptions extends ContextOptions<Date> {}
+/**
+ * @name isWeekend
+ * @category Weekday Helpers
+ * @summary Does the given date fall on a weekend?
+ *
+ * @description
+ * Does the given date fall on a weekend? A weekend is either Saturday (`6`) or Sunday (`0`).
+ *
+ * @param date - The date to check
+ * @param options - An object with options
+ *
+ * @returns The date falls on a weekend
+ *
+ * @example
+ * // Does 5 October 2014 fall on a weekend?
+ * const result = isWeekend(new Date(2014, 9, 5))
+ * //=> true
+ */
+export declare function isWeekend(
+  date: DateArg<Date> & {},
+  options?: IsWeekendOptions | undefined,
+): boolean;