-
Notifications
You must be signed in to change notification settings - Fork 8
/
index.d.ts
688 lines (602 loc) · 15.6 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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
declare module "react-date-object" {
export type DateType = Date | number | string | DateObject;
export type Calendar = {
name: string;
/**
* specifies what number the calendar year begins with.
* some calendars start with year 0
*/
startYear: number;
yearLength: number;
epoch: number;
century: number;
weekStartDayIndex: number;
/**
*
* @param isLeap
*
* return an array containing the number of days in each month.
*/
getMonthLengths(isLeap: boolean): number[];
isLeap(year: number): boolean;
/**
*
* @param currentYear
*
* returns all leap years including the current year
* (if the current year is a leap year).
*/
getLeaps(currentYear: number): number[] | [];
getDayOfYear(date: DateObject): number;
getAllDays(date: DateObject): number;
/**
*
* @param year
*
* Returns the number of leap years before the specified year.
*/
leapsLength?(year: number): number;
guessYear(days: number, currentYear: number): number;
};
export type Locale = {
name: string;
months: Array<string[]>;
weekDays: Array<string[]>;
digits: string[];
meridiems: Array<string[]>;
};
export type Month = {
name: string;
shortName: string;
number: number;
index: number;
/**
* specifies the number of days in this month.
*/
length: number;
valueOf(): number;
toString(): string;
};
export type WeekDay = Omit<Month, "length">;
export type Meridiem = {
name: string;
shortName: string;
};
export type ObjectType = {
year: number | undefined;
month: Month | undefined;
day: number | undefined;
weekDay: WeekDay | undefined;
hour: number | undefined;
minute: number | undefined;
second: number | undefined;
millisecond: number | undefined;
weekOfYear: number | undefined;
dayOfYear: number | undefined;
daysLeft: number | undefined;
calendar: Calendar;
locale: Locale;
format: string | undefined;
ignoreList: string[];
};
class DateObject {
constructor();
constructor(object: {
year: number;
month: number;
day: number;
hour?: number;
minute?: number;
second?: number;
millisecond?: number;
calendar?: Calendar;
locale?: Locale;
format?: string;
ignoreList?: string[];
});
constructor(object: {
date?: DateType;
calendar?: Calendar;
locale?: Locale;
format?: string;
ignoreList?: string[];
});
constructor(date: DateType);
/**
* Parse string from the given formatting token.
* Default formatting token: "YYYY MM DD hh mm ss SSS a".
*
* If you do not specify a formatting token, The default token is considered.
* @param date
* @example
* var date = new DateObject();
*
* date.setFormat("dddd DD MMMM YYYY");
* date.parse("Monday 24 August 2020");
*/
parse(date: string): this;
convert(calendar: Calendar | undefined, locale?: Locale): this;
/**
* Formatting current time from given token.
* Default token is "YYYY/MM/DD".
*
* If you do not specify a formatting token, The default token is considered.
* @param format
* @param ignoreList
* @example
* var date = new DateObject();
*
* date.format(); //2020/12/02
* date.format("MM/DD/YYYY"); //12/02/2020
*
* @example
* Ignoring `Date` & `Time`
*
* var date = new DateObject();
*
* date.format("Date:MM/DD/YYYY Time:HH:mm:ss", ["Date", "Time"]); //Date:12/02/2020 Time:11:03:12
*/
format(format?: string, ignoreList?: string[]): string;
getValue(key: string): number | string;
setYear(year: number): this;
/**
* Use this method if you want to specify the names of the months manually.
*
* @param months
* @example
*
* var Date = new DateObject()
*
* date.setMonths([
* ["jan", "j"],
* ["feb", "f"],
* ["mar", "m"],
* ["apr", "a"],
* ["may", "m"],
* ["jun", "j"],
* ["jul", "j"],
* ["aug", "a"],
* ["sep", "s"],
* ["oct", "o"],
* ["nov", "n"],
* ["dec", "d"],
* ])
*
* date.format("MMMM MMM") //dec d
*/
setMonths(months: Array<string[]>): this;
setMonth(month: number): this;
/**
* Use this method if you want to specify the names of week days manually.
*
* @param weekDays
* @example
*
* var Date = new DateObject()
*
* date.setWeekDays([
* ["su", "s"],
* ["mo", "m"],
* ["tu", "t"],
* ["we", "w"],
* ["th", "t"],
* ["fr", "f"],
* ["sa", "s"],
* ])
*
* date.format("dddd ddd") //su s
*/
setWeekDays(weekDays: Array<string[]>): this;
setDigits(digits: string[]): this;
/**
* @param dayOfMonth
*/
setDay(day: number): this;
setHour(hour: number): this;
setMinute(minute: number): this;
setSecond(second: number): this;
setMillisecond(millisecond: number): this;
/**
*
* @param formattingToken
* @example
* var date = new DateObject()
*
* date.setFormat("dddd MMMM YYYY")
*
* date.format() //Sunday December 2020
*/
setFormat(format?: string): this;
setLocale(locale: Locale): this;
setCalendar(calendar: Calendar | undefined): this;
setDate(date: DateType): this;
set(key: string, value: any): this;
set(obj: {
date?: DateType;
year?: number;
month?: number;
months?: Array<string[]>;
weekDays?: Array<string[]>;
day?: number;
hour?: number;
minute?: number;
second?: number;
millisecond?: number;
calendar?: Calendar;
locale?: Locale;
format?: string;
ignoreList?: string[];
digits?: string[];
}): this;
/**
* Availbe Types:
* - `years` `year` `y`
* - `months` `month` `M`
* - `days` `day` `d`
* - `hours` `hour` `h`
* - `minutes` `minute` `m`
* - `seconds` `second` `s`
* - `milliseconds` `millisecond` `ms`
*
* @param duration
* @param type
* @example
*
* var tomorrow = new DateObject().add(1, "day")
*/
add(duration: number | string, type: string): this;
/**
* Availbe Types:
* - `years` `year` `y`
* - `months` `month` `M`
* - `days` `day` `d`
* - `hours` `hour` `h`
* - `minutes` `minute` `m`
* - `seconds` `second` `s`
* - `milliseconds` `millisecond` `ms`
*
* @param duration
* @param type
* @example
*
* var yesterday = new DateObject().subtract(1, "day")
*/
subtract(duration: number | string, type: string): this;
toFirstOfYear(): this;
toLastOfYear(): this;
toFirstOfMonth(): this;
toLastOfMonth(): this;
toFirstOfWeek(): this;
toLastOfWeek(): this;
toFirstWeekOfYear(): this;
toLastWeekOfYear(): this;
toString(): string;
/**
* convert current calendar to JavaScript Date
*/
toDate(): Date;
/**
* convert current calendar to UTC
*/
toUTC(): this;
/**
* Unix time in seconds
*/
toUnix(): number;
toJulianDay(): number;
toObject(): ObjectType;
toJSON(): number;
/**
* Unix time in milliseconds
*/
valueOf(): number;
/**
* Count number of days passed from 1/1/1 (0/1/1 in indian calendar)
*/
toDays(): number;
/**
* Count number of days passed from current year
*/
dayOfYear: number;
/**
* Count number of weeks passed from current year
*/
weekOfYear: number;
/**
* Number of days remaining from current year
*/
daysLeft: number;
/**
* @get current year
* @set year
*/
year: number;
/**
* @get object (Month of year in current locale)
* @example { name: "January", shortName: "Jan", index: 0, number: 1 }
* @set number 1-12
*/
get month(): Month;
// set month(month: number);
get monthIndex(): number;
/**
* Day of month
* @get number
* @set number
*/
day: number;
/**
* Day of week in current locale
* @get object
* @example { name: "Sunday", shortName: "Sun", index: 0, number: 1 }
*/
get weekDay(): WeekDay;
/**
* @get current hour
* @set hour
*/
hour: number;
/**
* @get current minute
* @set minute
*/
minute: number;
/**
* @get current second
* @set second
*/
second: number;
/**
* @get current millisecond
* @set millisecond
*/
millisecond: number;
/**
* @get Array of months in current locale
* @example [{ name: "January", shortName: "Jan", index: 0, number: 1 }, ...]
* @set custom months
* @example [["name1" , "shortName1"], ["name2" , "shortName2"] ...]
* @example
*
* var Date = new DateObject()
*
* date.months = [
* ["jan", "j"],
* ["feb", "f"],
* ["mar", "m"],
* ["apr", "a"],
* ["may", "m"],
* ["jun", "j"],
* ["jul", "j"],
* ["aug", "a"],
* ["sep", "s"],
* ["oct", "o"],
* ["nov", "n"],
* ["dec", "d"],
* ]
*
* date.format("MMMM MMM") //dec d
*/
get months(): Month[];
// set months(months: string[]);
/**
* @get Array of week days in current locale
* @example [{ name: "Sunday", shortName: "Sun", index: 0, number: 1 }, ...]
* @set custom week days
* @example [["name1" , "shortName1"], ["name2" , "shortName2"] ...]
* @example
*
* var Date = new DateObject()
*
* date.setWeekDays([
* ["su", "s"],
* ["mo", "m"],
* ["tu", "t"],
* ["we", "w"],
* ["th", "t"],
* ["fr", "f"],
* ["sa", "s"],
* ])
*
* date.format("dddd ddd") //su s
*/
get weekDays(): WeekDay[];
// set weekDays(weekDays: string[]);
/**
* Array of leap years until now
*
* @example
*
* var date = new DateObject()
*
* date.leaps //[4, 8, 12, 16, 20, ...]
*/
leaps: number[];
get calendar(): Calendar;
set calendar(calendar: Calendar);
get locale(): Locale;
set locale(locale: Locale);
/**
* @get meridiems in current locale
* @example
*
* var date = new DateObject()
*
* date.meridiems //[{ name: "AM", shortName: "am" }, { name: "PM", shortName: "pm" }]
*/
get meridiems(): Meridiem[];
/**
* Array of locale numbers from 0 to 9
*/
digits: string[];
/**
* @get current formatting token
* @set formatting token
* @default "YYYY/MM/DD"
*
* var date = new DateObject()
*
* date._format = "dddd MMMM YYYY"
*
* date.format() //Sunday December 2020
*/
_format: string;
/**
* @get true if current year is leap
*/
isLeap: boolean;
/**
* @get true if the year, month and day are correct
*/
isValid: boolean;
isUTC: boolean;
/**
* @get Unix time in seconds
*/
unix: number;
/**
* formatting ignore list
*
* @example
* var date = new DateObject()
*
* date._format = "Date:MM/DD/YYYY"
* date.ignoreList = ["Date"]
*
* date.format() //Date:12/04/2020
*
* @example
* var date = new DateObject({
* format: "Date:MM/DD/YYYY",
* ignoreList: ["Date"]
* })
*
* date.format() //Date:12/04/2020
* date.format("time:hh:mm a", ["time"]) //time:06:50 pm
*/
ignoreList: string[];
custom: {
digits: string[] | undefined;
months: string[] | undefined;
weekDays: string[] | undefined;
};
set date(date: DateType);
weekStartDayIndex: number;
}
export default DateObject;
}
declare module "react-date-object/calendars/gregorian" {
import type { Calendar } from "react-date-object";
const gregorian: Calendar;
export default gregorian;
}
declare module "react-date-object/calendars/persian" {
import type { Calendar } from "react-date-object";
const persian: Omit<Calendar, "leapsLength">;
export default persian;
}
declare module "react-date-object/calendars/jalali" {
import type { Calendar } from "react-date-object";
const jalali: Calendar;
export default jalali;
}
declare module "react-date-object/calendars/arabic" {
import type { Calendar } from "react-date-object";
const arabic: Calendar;
export default arabic;
}
declare module "react-date-object/calendars/indian" {
import type { Calendar } from "react-date-object";
const indian: Calendar;
export default indian;
}
declare module "react-date-object/calendars/julian" {
import type { Calendar } from "react-date-object";
const julian: Calendar;
export = julian;
}
declare module "react-date-object/locales/gregorian_en" {
import type { Locale } from "react-date-object";
const gregorian_en: Locale;
export default gregorian_en;
}
declare module "react-date-object/locales/gregorian_fa" {
import type { Locale } from "react-date-object";
const gregorian_fa: Locale;
export default gregorian_fa;
}
declare module "react-date-object/locales/gregorian_ar" {
import type { Locale } from "react-date-object";
const gregorian_ar: Locale;
export default gregorian_ar;
}
declare module "react-date-object/locales/gregorian_hi" {
import type { Locale } from "react-date-object";
const gregorian_hi: Locale;
export default gregorian_hi;
}
declare module "react-date-object/locales/gregorian_pt_br" {
import type { Locale } from "react-date-object";
const gregorian_pt_br: Locale;
export default gregorian_pt_br;
}
declare module "react-date-object/locales/persian_en" {
import type { Locale } from "react-date-object";
const persian_en: Locale;
export default persian_en;
}
declare module "react-date-object/locales/persian_fa" {
import type { Locale } from "react-date-object";
const persian_fa: Locale;
export default persian_fa;
}
declare module "react-date-object/locales/persian_ar" {
import type { Locale } from "react-date-object";
const persian_ar: Locale;
export default persian_ar;
}
declare module "react-date-object/locales/persian_hi" {
import type { Locale } from "react-date-object";
const persian_hi: Locale;
export default persian_hi;
}
declare module "react-date-object/locales/arabic_en" {
import type { Locale } from "react-date-object";
const arabic_en: Locale;
export default arabic_en;
}
declare module "react-date-object/locales/arabic_fa" {
import type { Locale } from "react-date-object";
const arabic_fa: Locale;
export default arabic_fa;
}
declare module "react-date-object/locales/arabic_ar" {
import type { Locale } from "react-date-object";
const arabic_ar: Locale;
export default arabic_ar;
}
declare module "react-date-object/locales/arabic_hi" {
import type { Locale } from "react-date-object";
const arabic_hi: Locale;
export default arabic_hi;
}
declare module "react-date-object/locales/indian_en" {
import type { Locale } from "react-date-object";
const indian_en: Locale;
export default indian_en;
}
declare module "react-date-object/locales/indian_fa" {
import type { Locale } from "react-date-object";
const indian_fa: Locale;
export default indian_fa;
}
declare module "react-date-object/locales/indian_ar" {
import type { Locale } from "react-date-object";
const indian_ar: Locale;
export default indian_ar;
}
declare module "react-date-object/locales/indian_hi" {
import type { Locale } from "react-date-object";
const indian_hi: Locale;
export default indian_hi;
}