UNPKG

3.3 kBTypeScriptView Raw
1import { IUtils, DateIOFormats, Unit } from "@date-io/core/IUtils";
2import defaultLocale from "date-fns/locale/en-US";
3declare type Locale = typeof defaultLocale;
4export default class DateFnsUtils implements IUtils<Date> {
5 lib: string;
6 locale?: Locale;
7 formats: DateIOFormats;
8 constructor({ locale, formats, }?: {
9 formats?: Partial<DateIOFormats>;
10 locale?: Locale;
11 });
12 is12HourCycleInCurrentLocale: () => boolean;
13 getFormatHelperText: (format: string) => string;
14 parseISO: (isoString: string) => Date;
15 toISO: (value: Date) => string;
16 getCurrentLocaleCode: () => string;
17 addSeconds: (value: Date, count: number) => Date;
18 addMinutes: (value: Date, count: number) => Date;
19 addHours: (value: Date, count: number) => Date;
20 addDays: (value: Date, count: number) => Date;
21 addWeeks: (value: Date, count: number) => Date;
22 addMonths: (value: Date, count: number) => Date;
23 isValid: (value: any) => boolean;
24 getDiff: (value: Date, comparing: Date | string, unit?: Unit) => number;
25 isAfter: (value: Date, comparing: Date) => boolean;
26 isBefore: (value: Date, comparing: Date) => boolean;
27 startOfDay: (value: Date) => Date;
28 endOfDay: (value: Date) => Date;
29 getHours: (value: Date) => number;
30 setHours: (value: Date, count: number) => Date;
31 setMinutes: (value: Date, count: number) => Date;
32 getSeconds: (value: Date) => number;
33 setSeconds: (value: Date, count: number) => Date;
34 isSameDay: (value: Date, comparing: Date) => boolean;
35 isSameMonth: (value: Date, comparing: Date) => boolean;
36 isSameYear: (value: Date, comparing: Date) => boolean;
37 isSameHour: (value: Date, comparing: Date) => boolean;
38 startOfYear: (value: Date) => Date;
39 endOfYear: (value: Date) => Date;
40 startOfMonth: (value: Date) => Date;
41 endOfMonth: (value: Date) => Date;
42 startOfWeek: (value: Date) => Date;
43 endOfWeek: (value: Date) => Date;
44 getYear: (value: Date) => number;
45 setYear: (value: Date, count: number) => Date;
46 date: (value?: any) => Date;
47 toJsDate: (value: Date) => Date;
48 parse: (value: string, formatString: string) => Date;
49 format: (date: Date, formatKey: keyof DateIOFormats) => string;
50 formatByString: (date: Date, formatString: string) => string;
51 isEqual: (date: any, comparing: any) => boolean;
52 isNull: (date: Date) => boolean;
53 isAfterDay: (date: Date, value: Date) => boolean;
54 isBeforeDay: (date: Date, value: Date) => boolean;
55 isBeforeYear: (date: Date, value: Date) => boolean;
56 isAfterYear: (date: Date, value: Date) => boolean;
57 isWithinRange: (date: Date, [start, end]: [Date, Date]) => boolean;
58 formatNumber: (numberToFormat: string) => string;
59 getMinutes: (date: Date) => number;
60 getMonth: (date: Date) => number;
61 getDaysInMonth: (date: Date) => number;
62 setMonth: (date: Date, count: number) => Date;
63 getMeridiemText: (ampm: "am" | "pm") => "AM" | "PM";
64 getNextMonth: (date: Date) => Date;
65 getPreviousMonth: (date: Date) => Date;
66 getMonthArray: (date: Date) => Date[];
67 mergeDateAndTime: (date: Date, time: Date) => Date;
68 getWeekdays: () => string[];
69 getWeekArray: (date: Date) => Date[][];
70 getYearRange: (start: Date, end: Date) => Date[];
71}
72export {};