forked from date-fns/date-fns
-
Notifications
You must be signed in to change notification settings - Fork 0
/
typings.d.ts
17429 lines (13807 loc) · 455 KB
/
typings.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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
// FP Interfaces
interface CurriedFn1<A, R> {
<A>(a: A): R
}
interface CurriedFn2<A, B, R> {
<A>(a: A): CurriedFn1<B, R>
<A, B>(a: A, b: B): R
}
interface CurriedFn3<A, B, C, R> {
<A>(a: A): CurriedFn2<B, C, R>
<A,B>(a: A, b: B): CurriedFn1<C, R>
<A,B,C>(a: A, b: B, c: C): R
}
interface CurriedFn4<A, B, C, D, R> {
<A>(a: A): CurriedFn3<B, C, D, R>
<A,B>(a: A, b: B): CurriedFn2<C, D, R>
<A,B,C>(a: A, b: B, c: C): CurriedFn1<D, R>
<A,B,C,D>(a: A, b: B, c: C, d: D): R
}
// Type Aliases
type Interval = {
start: Date | string | number,
end: Date | string | number
}
type Options = {
weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
additionalDigits?: 0 | 1 | 2,
locale?: Locale,
includeSeconds?: boolean,
addSuffix?: boolean,
unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
roundingMethod?: 'floor' | 'ceil' | 'round'
}
type Locale = {
formatDistance: Function,
formatLong: Function,
formatRelative: Function,
localize: {
ordinalNumber: Function,
weekday: Function,
weekdays: Function,
month: Function,
months: Function,
timeOfDay: Function,
timesOfDay: Function
},
match: {
ordinalNumbers: Function,
ordinalNumber: Function,
weekdays: Function,
weekday: Function,
months: Function,
month: Function,
timesOfDay: Function,
timeOfDay: Function
},
formatters?: Object,
formattingTokensRegExp?: RegExp,
units?: Object,
parsers?: Object,
parsingTokensRegExp?: RegExp,
options?: {
weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
}
}
// Regular Functions
declare module 'date-fns' {
function addDays (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addDays {}
function addHours (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addHours {}
function addISOYears (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addISOYears {}
function addMilliseconds (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addMilliseconds {}
function addMinutes (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addMinutes {}
function addMonths (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addMonths {}
function addQuarters (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addQuarters {}
function addSeconds (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addSeconds {}
function addWeeks (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addWeeks {}
function addYears (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace addYears {}
function areIntervalsOverlapping (
intervalLeft: Interval,
intervalRight: Interval,
options?: Options
): boolean
namespace areIntervalsOverlapping {}
function closestIndexTo (
dateToCompare: Date | string | number,
datesArray: (Date | string | number)[],
options?: Options
): number
namespace closestIndexTo {}
function closestTo (
dateToCompare: Date | string | number,
datesArray: (Date | string | number)[],
options?: Options
): Date
namespace closestTo {}
function compareAsc (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace compareAsc {}
function compareDesc (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace compareDesc {}
function differenceInCalendarDays (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInCalendarDays {}
function differenceInCalendarISOWeeks (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInCalendarISOWeeks {}
function differenceInCalendarISOYears (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInCalendarISOYears {}
function differenceInCalendarMonths (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInCalendarMonths {}
function differenceInCalendarQuarters (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInCalendarQuarters {}
function differenceInCalendarWeeks (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInCalendarWeeks {}
function differenceInCalendarYears (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInCalendarYears {}
function differenceInDays (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInDays {}
function differenceInHours (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInHours {}
function differenceInISOYears (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInISOYears {}
function differenceInMilliseconds (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInMilliseconds {}
function differenceInMinutes (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInMinutes {}
function differenceInMonths (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInMonths {}
function differenceInQuarters (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInQuarters {}
function differenceInSeconds (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInSeconds {}
function differenceInWeeks (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInWeeks {}
function differenceInYears (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): number
namespace differenceInYears {}
function eachDayOfInterval (
interval: Interval,
options?: Options
): Date[]
namespace eachDayOfInterval {}
function endOfDay (
date: Date | string | number,
options?: Options
): Date
namespace endOfDay {}
function endOfHour (
date: Date | string | number,
options?: Options
): Date
namespace endOfHour {}
function endOfISOWeek (
date: Date | string | number,
options?: Options
): Date
namespace endOfISOWeek {}
function endOfISOYear (
date: Date | string | number,
options?: Options
): Date
namespace endOfISOYear {}
function endOfMinute (
date: Date | string | number,
options?: Options
): Date
namespace endOfMinute {}
function endOfMonth (
date: Date | string | number,
options?: Options
): Date
namespace endOfMonth {}
function endOfQuarter (
date: Date | string | number,
options?: Options
): Date
namespace endOfQuarter {}
function endOfSecond (
date: Date | string | number,
options?: Options
): Date
namespace endOfSecond {}
function endOfWeek (
date: Date | string | number,
options?: Options
): Date
namespace endOfWeek {}
function endOfYear (
date: Date | string | number,
options?: Options
): Date
namespace endOfYear {}
function format (
date: Date | string | number,
format: string,
options?: Options
): string
namespace format {}
function formatDistance (
date: Date | string | number,
baseDate: Date | string | number,
options?: Options
): string
namespace formatDistance {}
function formatDistanceStrict (
date: Date | string | number,
baseDate: Date | string | number,
options?: Options
): string
namespace formatDistanceStrict {}
function formatRelative (
date: Date | string | number,
baseDate: Date | string | number,
options?: Options
): string
namespace formatRelative {}
function getDate (
date: Date | string | number,
options?: Options
): number
namespace getDate {}
function getDay (
date: Date | string | number,
options?: Options
): number
namespace getDay {}
function getDayOfYear (
date: Date | string | number,
options?: Options
): number
namespace getDayOfYear {}
function getDaysInMonth (
date: Date | string | number,
options?: Options
): number
namespace getDaysInMonth {}
function getDaysInYear (
date: Date | string | number,
options?: Options
): number
namespace getDaysInYear {}
function getHours (
date: Date | string | number,
options?: Options
): number
namespace getHours {}
function getISODay (
date: Date | string | number,
options?: Options
): number
namespace getISODay {}
function getISOWeek (
date: Date | string | number,
options?: Options
): number
namespace getISOWeek {}
function getISOWeeksInYear (
date: Date | string | number,
options?: Options
): number
namespace getISOWeeksInYear {}
function getISOYear (
date: Date | string | number,
options?: Options
): number
namespace getISOYear {}
function getMilliseconds (
date: Date | string | number,
options?: Options
): number
namespace getMilliseconds {}
function getMinutes (
date: Date | string | number,
options?: Options
): number
namespace getMinutes {}
function getMonth (
date: Date | string | number,
options?: Options
): number
namespace getMonth {}
function getOverlappingDaysInIntervals (
intervalLeft: Interval,
intervalRight: Interval,
options?: Options
): number
namespace getOverlappingDaysInIntervals {}
function getQuarter (
date: Date | string | number,
options?: Options
): number
namespace getQuarter {}
function getSeconds (
date: Date | string | number,
options?: Options
): number
namespace getSeconds {}
function getTime (
date: Date | string | number,
options?: Options
): number
namespace getTime {}
function getYear (
date: Date | string | number,
options?: Options
): number
namespace getYear {}
function isAfter (
date: Date | string | number,
dateToCompare: Date | string | number,
options?: Options
): boolean
namespace isAfter {}
function isBefore (
date: Date | string | number,
dateToCompare: Date | string | number,
options?: Options
): boolean
namespace isBefore {}
function isEqual (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isEqual {}
function isFirstDayOfMonth (
date: Date | string | number,
options?: Options
): boolean
namespace isFirstDayOfMonth {}
function isFriday (
date: Date | string | number,
options?: Options
): boolean
namespace isFriday {}
function isLastDayOfMonth (
date: Date | string | number,
options?: Options
): boolean
namespace isLastDayOfMonth {}
function isLeapYear (
date: Date | string | number,
options?: Options
): boolean
namespace isLeapYear {}
function isMonday (
date: Date | string | number,
options?: Options
): boolean
namespace isMonday {}
function isSameDay (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameDay {}
function isSameHour (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameHour {}
function isSameISOWeek (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameISOWeek {}
function isSameISOYear (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameISOYear {}
function isSameMinute (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameMinute {}
function isSameMonth (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameMonth {}
function isSameQuarter (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameQuarter {}
function isSameSecond (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameSecond {}
function isSameWeek (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameWeek {}
function isSameYear (
dateLeft: Date | string | number,
dateRight: Date | string | number,
options?: Options
): boolean
namespace isSameYear {}
function isSaturday (
date: Date | string | number,
options?: Options
): boolean
namespace isSaturday {}
function isSunday (
date: Date | string | number,
options?: Options
): boolean
namespace isSunday {}
function isThursday (
date: Date | string | number,
options?: Options
): boolean
namespace isThursday {}
function isTuesday (
date: Date | string | number,
options?: Options
): boolean
namespace isTuesday {}
function isValid (
date: Date | string | number,
options?: Options
): boolean
namespace isValid {}
function isWednesday (
date: Date | string | number,
options?: Options
): boolean
namespace isWednesday {}
function isWeekend (
date: Date | string | number,
options?: Options
): boolean
namespace isWeekend {}
function isWithinInterval (
date: Date | string | number,
interval: Interval,
options?: Options
): boolean
namespace isWithinInterval {}
function lastDayOfISOWeek (
date: Date | string | number,
options?: Options
): Date
namespace lastDayOfISOWeek {}
function lastDayOfISOYear (
date: Date | string | number,
options?: Options
): Date
namespace lastDayOfISOYear {}
function lastDayOfMonth (
date: Date | string | number,
options?: Options
): Date
namespace lastDayOfMonth {}
function lastDayOfQuarter (
date: Date | string | number,
options?: Options
): Date
namespace lastDayOfQuarter {}
function lastDayOfWeek (
date: Date | string | number,
options?: Options
): Date
namespace lastDayOfWeek {}
function lastDayOfYear (
date: Date | string | number,
options?: Options
): Date
namespace lastDayOfYear {}
function max (
datesArray: (Date | string | number)[],
options?: Options
): Date
namespace max {}
function min (
datesArray: (Date | string | number)[],
options?: Options
): Date
namespace min {}
function parse (
dateString: string,
formatString: string,
baseDate: Date | string | number,
options?: Options
): Date
namespace parse {}
function setDate (
date: Date | string | number,
dayOfMonth: number,
options?: Options
): Date
namespace setDate {}
function setDay (
date: Date | string | number,
day: number,
options?: Options
): Date
namespace setDay {}
function setDayOfYear (
date: Date | string | number,
dayOfYear: number,
options?: Options
): Date
namespace setDayOfYear {}
function setHours (
date: Date | string | number,
hours: number,
options?: Options
): Date
namespace setHours {}
function setISODay (
date: Date | string | number,
day: number,
options?: Options
): Date
namespace setISODay {}
function setISOWeek (
date: Date | string | number,
isoWeek: number,
options?: Options
): Date
namespace setISOWeek {}
function setISOYear (
date: Date | string | number,
isoYear: number,
options?: Options
): Date
namespace setISOYear {}
function setMilliseconds (
date: Date | string | number,
milliseconds: number,
options?: Options
): Date
namespace setMilliseconds {}
function setMinutes (
date: Date | string | number,
minutes: number,
options?: Options
): Date
namespace setMinutes {}
function setMonth (
date: Date | string | number,
month: number,
options?: Options
): Date
namespace setMonth {}
function setQuarter (
date: Date | string | number,
quarter: number,
options?: Options
): Date
namespace setQuarter {}
function setSeconds (
date: Date | string | number,
seconds: number,
options?: Options
): Date
namespace setSeconds {}
function setYear (
date: Date | string | number,
year: number,
options?: Options
): Date
namespace setYear {}
function startOfDay (
date: Date | string | number,
options?: Options
): Date
namespace startOfDay {}
function startOfHour (
date: Date | string | number,
options?: Options
): Date
namespace startOfHour {}
function startOfISOWeek (
date: Date | string | number,
options?: Options
): Date
namespace startOfISOWeek {}
function startOfISOYear (
date: Date | string | number,
options?: Options
): Date
namespace startOfISOYear {}
function startOfMinute (
date: Date | string | number,
options?: Options
): Date
namespace startOfMinute {}
function startOfMonth (
date: Date | string | number,
options?: Options
): Date
namespace startOfMonth {}
function startOfQuarter (
date: Date | string | number,
options?: Options
): Date
namespace startOfQuarter {}
function startOfSecond (
date: Date | string | number,
options?: Options
): Date
namespace startOfSecond {}
function startOfWeek (
date: Date | string | number,
options?: Options
): Date
namespace startOfWeek {}
function startOfYear (
date: Date | string | number,
options?: Options
): Date
namespace startOfYear {}
function subDays (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subDays {}
function subHours (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subHours {}
function subISOYears (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subISOYears {}
function subMilliseconds (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subMilliseconds {}
function subMinutes (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subMinutes {}
function subMonths (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subMonths {}
function subQuarters (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subQuarters {}
function subSeconds (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subSeconds {}
function subWeeks (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subWeeks {}
function subYears (
date: Date | string | number,
amount: number,
options?: Options
): Date
namespace subYears {}
function toDate (
argument: Date | string | number,
options?: Options
): Date
namespace toDate {}
}
declare module 'date-fns/addDays' {
import {addDays} from 'date-fns'
export = addDays
}
declare module 'date-fns/addHours' {
import {addHours} from 'date-fns'
export = addHours
}
declare module 'date-fns/addISOYears' {
import {addISOYears} from 'date-fns'
export = addISOYears
}
declare module 'date-fns/addMilliseconds' {
import {addMilliseconds} from 'date-fns'
export = addMilliseconds
}
declare module 'date-fns/addMinutes' {
import {addMinutes} from 'date-fns'
export = addMinutes
}
declare module 'date-fns/addMonths' {
import {addMonths} from 'date-fns'
export = addMonths
}
declare module 'date-fns/addQuarters' {
import {addQuarters} from 'date-fns'
export = addQuarters
}
declare module 'date-fns/addSeconds' {
import {addSeconds} from 'date-fns'
export = addSeconds
}