@duetds/date-picker/dist/types/components/duet-date-picker/date-utils.d.ts

Duet Date Picker is an open source version of Duet Design System’s accessible date picker.

export declare enum DaysOfWeek {
  Sunday = 0,
  Monday = 1,
  Tuesday = 2,
  Wednesday = 3,
  Thursday = 4,
  Friday = 5,
  Saturday = 6
}
export declare function createDate(year: string, month: string, day: string): Date;
/**
 * @param value date string in ISO format YYYY-MM-DD
 */
export declare function parseISODate(value: string): Date;
/**
 * print date in format YYYY-MM-DD
 * @param date
 */
export declare function printISODate(date: Date): string;
/**
 * Compare if two dates are equal in terms of day, month, and year
 */
export declare function isEqual(a: Date, b: Date): boolean;
/**
 * Compare if two dates are in the same month of the same year.
 */
export declare function isEqualMonth(a: Date, b: Date): boolean;
export declare function addDays(date: Date, days: number): Date;
export declare function addMonths(date: Date, months: number): Date;
export declare function addYears(date: Date, years: number): Date;
export declare function startOfWeek(date: Date, firstDayOfWeek?: DaysOfWeek): Date;
export declare function endOfWeek(date: Date, firstDayOfWeek?: DaysOfWeek): Date;
export declare function startOfMonth(date: Date): Date;
export declare function endOfMonth(date: Date): Date;
export declare function setMonth(date: Date, month: number): Date;
export declare function setYear(date: Date, year: number): Date;
/**
 * Check if date is within a min and max
 */
export declare function inRange(date: Date, min?: Date, max?: Date): boolean;
/**
 * Ensures date is within range, returns min or max if out of bounds
 */
export declare function clamp(date: Date, min?: Date, max?: Date): Date;
/**
 * given a date, return an array of dates from a calendar perspective
 * @param date
 * @param firstDayOfWeek
 */
export declare function getViewOfMonth(date: Date, firstDayOfWeek?: DaysOfWeek): Date[];
/**
 * Form random hash
 */
export declare function chr4(): string;
/**
 * Create random identifier with a prefix
 * @param prefix
 */
export declare function createIdentifier(prefix: any): string;