react-day-picker
Version:
Customizable Date Picker for React
84 lines (77 loc) • 2.39 kB
text/typescript
import type { DateLib } from "../classes/DateLib.js";
import type {
DateAfter,
DateBefore,
DateInterval,
DateRange,
DayOfWeek
} from "../types/index.js";
/**
* Checks if the given value is of type {@link DateInterval}.
*
* @param matcher - The value to check.
* @returns `true` if the value is a {@link DateInterval}, otherwise `false`.
* @group Utilities
*/
export function isDateInterval(matcher: unknown): matcher is DateInterval {
return Boolean(
matcher &&
typeof matcher === "object" &&
"before" in matcher &&
"after" in matcher
);
}
/**
* Checks if the given value is of type {@link DateRange}.
*
* @param value - The value to check.
* @returns `true` if the value is a {@link DateRange}, otherwise `false`.
* @group Utilities
*/
export function isDateRange(value: unknown): value is DateRange {
return Boolean(value && typeof value === "object" && "from" in value);
}
/**
* Checks if the given value is of type {@link DateAfter}.
*
* @param value - The value to check.
* @returns `true` if the value is a {@link DateAfter}, otherwise `false`.
* @group Utilities
*/
export function isDateAfterType(value: unknown): value is DateAfter {
return Boolean(value && typeof value === "object" && "after" in value);
}
/**
* Checks if the given value is of type {@link DateBefore}.
*
* @param value - The value to check.
* @returns `true` if the value is a {@link DateBefore}, otherwise `false`.
* @group Utilities
*/
export function isDateBeforeType(value: unknown): value is DateBefore {
return Boolean(value && typeof value === "object" && "before" in value);
}
/**
* Checks if the given value is of type {@link DayOfWeek}.
*
* @param value - The value to check.
* @returns `true` if the value is a {@link DayOfWeek}, otherwise `false`.
* @group Utilities
*/
export function isDayOfWeekType(value: unknown): value is DayOfWeek {
return Boolean(value && typeof value === "object" && "dayOfWeek" in value);
}
/**
* Checks if the given value is an array of valid dates.
*
* @private
* @param value - The value to check.
* @param dateLib - The date utility library instance.
* @returns `true` if the value is an array of valid dates, otherwise `false`.
*/
export function isDatesArray(
value: unknown,
dateLib: DateLib
): value is Date[] {
return Array.isArray(value) && value.every(dateLib.isDate);
}