UNPKG

3.44 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 addYears: (value: Date, count: number) => Date;
24 isValid: (value: any) => boolean;
25 getDiff: (value: Date, comparing: Date | string, unit?: Unit) => number;
26 isAfter: (value: Date, comparing: Date) => boolean;
27 isBefore: (value: Date, comparing: Date) => boolean;
28 startOfDay: (value: Date) => Date;
29 endOfDay: (value: Date) => Date;
30 getHours: (value: Date) => number;
31 setHours: (value: Date, count: number) => Date;
32 setMinutes: (value: Date, count: number) => Date;
33 getSeconds: (value: Date) => number;
34 setSeconds: (value: Date, count: number) => Date;
35 isSameDay: (value: Date, comparing: Date) => boolean;
36 isSameMonth: (value: Date, comparing: Date) => boolean;
37 isSameYear: (value: Date, comparing: Date) => boolean;
38 isSameHour: (value: Date, comparing: Date) => boolean;
39 startOfYear: (value: Date) => Date;
40 endOfYear: (value: Date) => Date;
41 startOfMonth: (value: Date) => Date;
42 endOfMonth: (value: Date) => Date;
43 startOfWeek: (value: Date) => Date;
44 endOfWeek: (value: Date) => Date;
45 getYear: (value: Date) => number;
46 setYear: (value: Date, count: number) => Date;
47 date: (value?: any) => Date;
48 toJsDate: (value: Date) => Date;
49 parse: (value: string, formatString: string) => Date;
50 format: (date: Date, formatKey: keyof DateIOFormats) => string;
51 formatByString: (date: Date, formatString: string) => string;
52 isEqual: (date: any, comparing: any) => boolean;
53 isNull: (date: Date) => boolean;
54 isAfterDay: (date: Date, value: Date) => boolean;
55 isBeforeDay: (date: Date, value: Date) => boolean;
56 isBeforeYear: (date: Date, value: Date) => boolean;
57 isAfterYear: (date: Date, value: Date) => boolean;
58 isWithinRange: (date: Date, [start, end]: [Date, Date]) => boolean;
59 formatNumber: (numberToFormat: string) => string;
60 getMinutes: (date: Date) => number;
61 getDate: (date: Date) => number;
62 setDate: (date: Date, count: number) => Date;
63 getMonth: (date: Date) => number;
64 getDaysInMonth: (date: Date) => number;
65 setMonth: (date: Date, count: number) => Date;
66 getMeridiemText: (ampm: "am" | "pm") => "AM" | "PM";
67 getNextMonth: (date: Date) => Date;
68 getPreviousMonth: (date: Date) => Date;
69 getMonthArray: (date: Date) => Date[];
70 mergeDateAndTime: (date: Date, time: Date) => Date;
71 getWeekdays: () => string[];
72 getWeekArray: (date: Date) => Date[][];
73 getYearRange: (start: Date, end: Date) => Date[];
74}
75export {};