/
index.d.ts
315 lines (280 loc) · 5.86 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
/**
* Integer number
* */
declare type Integer = number
/**
* Format: /^\d\d$/
* */
declare type NumberStr = string
declare type IntegerStr = Integer | NumberStr
declare enum DefaultMax {
Hour = 23,
Minute = 59,
Second = 59,
}
/**
* Format: /^(\d{4})-?(\d{1,2})?-?(\d{1,2})?$/
* */
declare type DateStr = string
/**
* Format: /^(\d{1,2}):?(\d{1,2})?:?(\d{1,2})?$/
* */
declare type TimeStr = string
interface GetResultItem<M extends DefaultMax> {
value: NumberStr
max: M
canBeChose: boolean
}
interface GetOptions {
interval?: Integer
min?: Integer
max?: Integer
}
interface DateInfoBase {
/**
* String that already been formatted, such as `2020`
*
* 已格式化的字符串,例如:`2020`
* */
year: NumberStr
/**
* String that already been formatted, such as `02`
*
* 已格式化的字符串,例如:`02`
* */
month: NumberStr
/**
* String that already been formatted, such as `01`
*
* 已格式化的字符串,例如:`01`
* */
date: NumberStr
}
interface DateInfoBase1 {
year: IntegerStr
month: IntegerStr
date: IntegerStr
}
interface TimeInfo {
/**
* String that already been formatted, such as `02`
*
* 已格式化的字符串,例如:`02`
* */
hour: NumberStr
/**
* String that already been formatted, such as `02`
*
* 已格式化的字符串,例如:`02`
* */
minute: NumberStr
/**
* String that already been formatted, such as `02`
*
* 已格式化的字符串,例如:`02`
* */
second: NumberStr
}
interface DateInfo extends DateInfoBase {
isInThisMonth: boolean
isNow: boolean
canBeChose: boolean
}
interface GntCalendarOptions {
/**
* Min date
* */
min?: DateInfoBase1 | DateStr
/**
* Max date
* */
max?: DateInfoBase1 | DateStr
/**
* The start day of the week
*
* Default is 0 (Sunday)
* */
firstDayOfWeek?: number
}
interface MonthInfo {
/**
* String that already been formatted, such as `2020`
*
* 已格式化的字符串,例如:`2020`
* */
year: NumberStr
/**
* String that already been formatted, such as `02`
*
* 已格式化的字符串,例如:`02`
* */
month: NumberStr
canBeChose: boolean
isNow: boolean
}
interface GntMonthOptions {
/**
* Default: 3
* */
splitLen?: number
/**
* Min Month
* */
min?: Pick<DateInfoBase1, 'year' | 'month'> | DateStr
/**
* Max Month
* */
max?: Pick<DateInfoBase1, 'year' | 'month'> | DateStr
}
interface GntYearOptions {
/**
* Default: 3
* */
splitLen?: number
/**
* Min year
* */
min?: Integer
/**
* Max year
* */
max?: Integer
}
interface YearInfo {
/**
* String that already been formatted, such as `2020`
*
* 已格式化的字符串,例如:`2020`
* */
year: NumberStr
canBeChose: boolean
isNow: boolean
}
declare enum DateCompare {
GreatThanYear = 100,
GreatThanMonth = 10,
GreatThanDate = 1,
Equal = 0,
LessThanDate = -1,
LessThanMonth = -10,
LessThanYear = -100,
}
declare function compareDates(
date1: DateInfoBase1 | DateStr,
date2: DateInfoBase1 | DateStr,
): DateCompare
declare function calcStepBetweenDates(
date: DateInfoBase1 | DateStr,
targetDate: DateInfoBase1 | DateStr,
): number
declare function gntCalendar(
monthInfo:
| {
year: IntegerStr
month: IntegerStr
}
| DateStr,
options?: GntCalendarOptions,
): typeof monthInfo extends DateStr ? DateInfo[][] | null : DateInfo[][]
declare function getDateByStep(
currDate:
| {
year: IntegerStr
month: IntegerStr
date: IntegerStr
}
| DateStr,
step: Integer,
): typeof currDate extends DateStr ? DateInfoBase | null : DateInfoBase
declare const getHour: (
options?: GetOptions | undefined,
) => GetResultItem<DefaultMax.Hour>[]
declare const getMinute: (
options?: GetOptions | undefined,
) => GetResultItem<DefaultMax.Minute>[]
declare const getSecond: (
options?: GetOptions | undefined,
) => GetResultItem<DefaultMax.Minute>[]
declare function gntMonth(
year: IntegerStr,
options?: GntMonthOptions,
): MonthInfo[][]
declare function getMonthByStep(
currMonth:
| {
year: IntegerStr
month: IntegerStr
}
| DateStr,
step: Integer,
): typeof currMonth extends DateStr
? Pick<MonthInfo, 'year' | 'month'> | null
: Pick<MonthInfo, 'year' | 'month'>
declare function fillTo(width: Integer, num: IntegerStr, pad?: string): string
declare function isNonNegInt(num: IntegerStr): boolean
declare function objAssign<T extends any, U extends any>(o1: T, o2: U): T & U
declare function positiveMod(val: number, div: number): number
declare function isLeapYear(year: IntegerStr): boolean
declare function getMonthLen(
year: IntegerStr,
month: IntegerStr,
): 29 | 28 | 31 | 30
declare function getIntervalVal<T extends DefaultMax>(
defaultMax: T,
): (options?: GetOptions | undefined) => GetResultItem<T>[]
declare function parseDate(date: DateStr): DateInfoBase | null
declare function parseTime(time: TimeStr): TimeInfo | null
declare function nowDate(): DateInfoBase
declare function nowTime(): TimeInfo
declare function getDay(
year: IntegerStr,
month: IntegerStr,
date: IntegerStr,
): number
declare function gntYear(
start: IntegerStr,
len: Integer,
options?: GntYearOptions,
): YearInfo[][]
export {
DateCompare,
DateInfo,
DateInfoBase,
DateInfoBase1,
DateStr,
DefaultMax,
GetOptions,
GetResultItem,
GntCalendarOptions,
GntMonthOptions,
GntYearOptions,
Integer,
IntegerStr,
MonthInfo,
NumberStr,
TimeInfo,
TimeStr,
YearInfo,
calcStepBetweenDates,
compareDates,
fillTo,
getDateByStep,
getDay,
getHour,
getIntervalVal,
getMinute,
getMonthByStep,
getMonthLen,
getSecond,
gntCalendar,
gntMonth,
gntYear,
isLeapYear,
isNonNegInt,
nowDate,
nowTime,
objAssign,
parseDate,
parseTime,
positiveMod,
}