forked from jbaroudi/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
timezonecomplete.d.ts
1520 lines (1510 loc) · 65.1 KB
/
timezonecomplete.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
// Type definitions for timezonecomplete 1.15.0
// Project: https://github.com/SpiritIT/timezonecomplete
// Definitions by: Rogier Schouten <https://github.com/rogierschouten>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
declare module 'timezonecomplete' {
import basics = require("__timezonecomplete/basics");
export import TimeUnit = basics.TimeUnit;
export import WeekDay = basics.WeekDay;
export import timeUnitToMilliseconds = basics.timeUnitToMilliseconds;
export import isLeapYear = basics.isLeapYear;
export import daysInMonth = basics.daysInMonth;
export import daysInYear = basics.daysInYear;
export import firstWeekDayOfMonth = basics.firstWeekDayOfMonth;
export import lastWeekDayOfMonth = basics.lastWeekDayOfMonth;
export import weekDayOnOrAfter = basics.weekDayOnOrAfter;
export import weekDayOnOrBefore = basics.weekDayOnOrBefore;
export import weekNumber = basics.weekNumber;
export import weekOfMonth = basics.weekOfMonth;
export import dayOfYear = basics.dayOfYear;
export import secondOfDay = basics.secondOfDay;
export import timeUnitToString = basics.timeUnitToString;
export import stringToTimeUnit = basics.stringToTimeUnit;
import datetime = require("__timezonecomplete/datetime");
export import DateTime = datetime.DateTime;
export import now = datetime.now;
export import nowLocal = datetime.nowLocal;
export import nowUtc = datetime.nowUtc;
import duration = require("__timezonecomplete/duration");
export import Duration = duration.Duration;
export import years = duration.years;
export import months = duration.months;
export import days = duration.days;
export import hours = duration.hours;
export import minutes = duration.minutes;
export import seconds = duration.seconds;
export import milliseconds = duration.milliseconds;
import javascript = require("__timezonecomplete/javascript");
export import DateFunctions = javascript.DateFunctions;
import period = require("__timezonecomplete/period");
export import Period = period.Period;
export import PeriodDst = period.PeriodDst;
export import periodDstToString = period.periodDstToString;
import timesource = require("__timezonecomplete/timesource");
export import TimeSource = timesource.TimeSource;
export import RealTimeSource = timesource.RealTimeSource;
import timezone = require("__timezonecomplete/timezone");
export import NormalizeOption = timezone.NormalizeOption;
export import TimeZoneKind = timezone.TimeZoneKind;
export import TimeZone = timezone.TimeZone;
export import local = timezone.local;
export import utc = timezone.utc;
export import zone = timezone.zone;
import globals = require("__timezonecomplete/globals");
export import min = globals.min;
export import max = globals.max;
}
declare module '__timezonecomplete/basics' {
import javascript = require("__timezonecomplete/javascript");
import DateFunctions = javascript.DateFunctions;
/**
* Day-of-week. Note the enum values correspond to JavaScript day-of-week:
* Sunday = 0, Monday = 1 etc
*/
export enum WeekDay {
Sunday = 0,
Monday = 1,
Tuesday = 2,
Wednesday = 3,
Thursday = 4,
Friday = 5,
Saturday = 6,
}
/**
* Time units
*/
export enum TimeUnit {
Millisecond = 0,
Second = 1,
Minute = 2,
Hour = 3,
Day = 4,
Week = 5,
Month = 6,
Year = 7,
/**
* End-of-enum marker, do not use
*/
MAX = 8,
}
/**
* Approximate number of milliseconds for a time unit.
* A day is assumed to have 24 hours, a month is assumed to equal 30 days
* and a year is set to 360 days (because 12 months of 30 days).
*
* @param unit Time unit e.g. TimeUnit.Month
* @returns The number of milliseconds.
*/
export function timeUnitToMilliseconds(unit: TimeUnit): number;
/**
* Time unit to lowercase string. If amount is specified, then the string is put in plural form
* if necessary.
* @param unit The unit
* @param amount If this is unequal to -1 and 1, then the result is pluralized
*/
export function timeUnitToString(unit: TimeUnit, amount?: number): string;
export function stringToTimeUnit(s: string): TimeUnit;
/**
* @return True iff the given year is a leap year.
*/
export function isLeapYear(year: number): boolean;
/**
* The days in a given year
*/
export function daysInYear(year: number): number;
/**
* @param year The full year
* @param month The month 1-12
* @return The number of days in the given month
*/
export function daysInMonth(year: number, month: number): number;
/**
* Returns the day of the year of the given date [0..365]. January first is 0.
*
* @param year The year e.g. 1986
* @param month Month 1-12
* @param day Day of month 1-31
*/
export function dayOfYear(year: number, month: number, day: number): number;
/**
* Returns the last instance of the given weekday in the given month
*
* @param year The year
* @param month the month 1-12
* @param weekDay the desired week day
*
* @return the last occurrence of the week day in the month
*/
export function lastWeekDayOfMonth(year: number, month: number, weekDay: WeekDay): number;
/**
* Returns the first instance of the given weekday in the given month
*
* @param year The year
* @param month the month 1-12
* @param weekDay the desired week day
*
* @return the first occurrence of the week day in the month
*/
export function firstWeekDayOfMonth(year: number, month: number, weekDay: WeekDay): number;
/**
* Returns the day-of-month that is on the given weekday and which is >= the given day.
* Throws if the month has no such day.
*/
export function weekDayOnOrAfter(year: number, month: number, day: number, weekDay: WeekDay): number;
/**
* Returns the day-of-month that is on the given weekday and which is <= the given day.
* Throws if the month has no such day.
*/
export function weekDayOnOrBefore(year: number, month: number, day: number, weekDay: WeekDay): number;
/**
* The week of this month. There is no official standard for this,
* but we assume the same rules for the weekNumber (i.e.
* week 1 is the week that has the 4th day of the month in it)
*
* @param year The year
* @param month The month [1-12]
* @param day The day [1-31]
* @return Week number [1-5]
*/
export function weekOfMonth(year: number, month: number, day: number): number;
/**
* The ISO 8601 week number for the given date. Week 1 is the week
* that has January 4th in it, and it starts on Monday.
* See https://en.wikipedia.org/wiki/ISO_week_date
*
* @param year Year e.g. 1988
* @param month Month 1-12
* @param day Day of month 1-31
*
* @return Week number 1-53
*/
export function weekNumber(year: number, month: number, day: number): number;
/**
* Convert a unix milli timestamp into a TimeT structure.
* This does NOT take leap seconds into account.
*/
export function unixToTimeNoLeapSecs(unixMillis: number): TimeStruct;
/**
* Convert a year, month, day etc into a unix milli timestamp.
* This does NOT take leap seconds into account.
*
* @param year Year e.g. 1970
* @param month Month 1-12
* @param day Day 1-31
* @param hour Hour 0-23
* @param minute Minute 0-59
* @param second Second 0-59 (no leap seconds)
* @param milli Millisecond 0-999
*/
export function timeToUnixNoLeapSecs(year?: number, month?: number, day?: number, hour?: number, minute?: number, second?: number, milli?: number): number;
/**
* Convert a TimeT structure into a unix milli timestamp.
* This does NOT take leap seconds into account.
*/
export function timeToUnixNoLeapSecs(tm: TimeStruct): number;
/**
* Return the day-of-week.
* This does NOT take leap seconds into account.
*/
export function weekDayNoLeapSecs(unixMillis: number): WeekDay;
/**
* N-th second in the day, counting from 0
*/
export function secondOfDay(hour: number, minute: number, second: number): number;
/**
* Basic representation of a date and time
*/
export class TimeStruct {
/**
* Year, 1970-...
*/
year: number;
/**
* Month 1-12
*/
month: number;
/**
* Day of month, 1-31
*/
day: number;
/**
* Hour 0-23
*/
hour: number;
/**
* Minute 0-59
*/
minute: number;
/**
* Seconds, 0-59
*/
second: number;
/**
* Milliseconds 0-999
*/
milli: number;
/**
* Create a TimeStruct from a number of unix milliseconds
*/
static fromUnix(unixMillis: number): TimeStruct;
/**
* Create a TimeStruct from a JavaScript date
*
* @param d The date
* @param df Which functions to take (getX() or getUTCX())
*/
static fromDate(d: Date, df: DateFunctions): TimeStruct;
/**
* Returns a TimeStruct from an ISO 8601 string WITHOUT time zone
*/
static fromString(s: string): TimeStruct;
/**
* Constructor
*
* @param year Year e.g. 1970
* @param month Month 1-12
* @param day Day 1-31
* @param hour Hour 0-23
* @param minute Minute 0-59
* @param second Second 0-59 (no leap seconds)
* @param milli Millisecond 0-999
*/
constructor(
/**
* Year, 1970-...
*/
year?: number,
/**
* Month 1-12
*/
month?: number,
/**
* Day of month, 1-31
*/
day?: number,
/**
* Hour 0-23
*/
hour?: number,
/**
* Minute 0-59
*/
minute?: number,
/**
* Seconds, 0-59
*/
second?: number,
/**
* Milliseconds 0-999
*/
milli?: number);
/**
* Validate a TimeStruct, returns false if invalid.
*/
validate(): boolean;
/**
* The day-of-year 0-365
*/
yearDay(): number;
/**
* Returns this time as a unix millisecond timestamp
* Does NOT take leap seconds into account.
*/
toUnixNoLeapSecs(): number;
/**
* Deep equals
*/
equals(other: TimeStruct): boolean;
/**
* < operator
*/
lessThan(other: TimeStruct): boolean;
clone(): TimeStruct;
valueOf(): number;
/**
* ISO 8601 string YYYY-MM-DDThh:mm:ss.nnn
*/
toString(): string;
inspect(): string;
}
}
declare module '__timezonecomplete/datetime' {
import basics = require("__timezonecomplete/basics");
import WeekDay = basics.WeekDay;
import TimeUnit = basics.TimeUnit;
import duration = require("__timezonecomplete/duration");
import Duration = duration.Duration;
import javascript = require("__timezonecomplete/javascript");
import DateFunctions = javascript.DateFunctions;
import timesource = require("__timezonecomplete/timesource");
import TimeSource = timesource.TimeSource;
import timezone = require("__timezonecomplete/timezone");
import TimeZone = timezone.TimeZone;
/**
* Current date+time in local time
*/
export function nowLocal(): DateTime;
/**
* Current date+time in UTC time
*/
export function nowUtc(): DateTime;
/**
* Current date+time in the given time zone
* @param timeZone The desired time zone (optional, defaults to UTC).
*/
export function now(timeZone?: TimeZone): DateTime;
/**
* DateTime class which is time zone-aware
* and which can be mocked for testing purposes.
*/
export class DateTime {
/**
* Actual time source in use. Setting this property allows to
* fake time in tests. DateTime.nowLocal() and DateTime.nowUtc()
* use this property for obtaining the current time.
*/
static timeSource: TimeSource;
/**
* Current date+time in local time
*/
static nowLocal(): DateTime;
/**
* Current date+time in UTC time
*/
static nowUtc(): DateTime;
/**
* Current date+time in the given time zone
* @param timeZone The desired time zone (optional, defaults to UTC).
*/
static now(timeZone?: TimeZone): DateTime;
/**
* Create a DateTime from a Lotus 123 / Microsoft Excel date-time value
* i.e. a double representing days since 1-1-1900 where 1900 is incorrectly seen as leap year
*/
static fromExcel(n: number, timeZone?: TimeZone): DateTime;
/**
* Constructor. Creates current time in local timezone.
*/
constructor();
/**
* Constructor
* Non-existing local times are normalized by rounding up to the next DST offset.
*
* @param isoString String in ISO 8601 format. Instead of ISO time zone,
* it may include a space and then and IANA time zone.
* e.g. "2007-04-05T12:30:40.500" (no time zone, naive date)
* e.g. "2007-04-05T12:30:40.500+01:00" (UTC offset without daylight saving time)
* or "2007-04-05T12:30:40.500Z" (UTC)
* or "2007-04-05T12:30:40.500 Europe/Amsterdam" (IANA time zone, with daylight saving time if applicable)
* @param timeZone if given, the date in the string is assumed to be in this time zone.
* Note that it is NOT CONVERTED to the time zone. Useful
* for strings without a time zone
*/
constructor(isoString: string, timeZone?: TimeZone);
/**
* Constructor. You provide a date, then you say whether to take the
* date.getYear()/getXxx methods or the date.getUTCYear()/date.getUTCXxx methods,
* and then you state which time zone that date is in.
* Non-existing local times are normalized by rounding up to the next DST offset.
* Note that the Date class has bugs and inconsistencies when constructing them with times around
* DST changes.
*
* @param date A date object.
* @param getters Specifies which set of Date getters contains the date in the given time zone: the
* Date.getXxx() methods or the Date.getUTCXxx() methods.
* @param timeZone The time zone that the given date is assumed to be in (may be null for unaware dates)
*/
constructor(date: Date, getFuncs: DateFunctions, timeZone?: TimeZone);
/**
* Constructor. Note that unlike JavaScript dates we require fields to be in normal ranges.
* Use the add(duration) or sub(duration) for arithmetic.
* @param year The full year (e.g. 2014)
* @param month The month [1-12] (note this deviates from JavaScript Date)
* @param day The day of the month [1-31]
* @param hour The hour of the day [0-24)
* @param minute The minute of the hour [0-59]
* @param second The second of the minute [0-59]
* @param millisecond The millisecond of the second [0-999]
* @param timeZone The time zone, or null (for unaware dates)
*/
constructor(year: number, month: number, day: number, hour?: number, minute?: number, second?: number, millisecond?: number, timeZone?: TimeZone);
/**
* Constructor
* @param unixTimestamp milliseconds since 1970-01-01T00:00:00.000
* @param timeZone the time zone that the timestamp is assumed to be in (usually UTC).
*/
constructor(unixTimestamp: number, timeZone?: TimeZone);
/**
* @return a copy of this object
*/
clone(): DateTime;
/**
* @return The time zone that the date is in. May be null for unaware dates.
*/
zone(): TimeZone;
/**
* Zone name abbreviation at this time
* @param dstDependent (default true) set to false for a DST-agnostic abbreviation
* @return The abbreviation
*/
zoneAbbreviation(dstDependent?: boolean): string;
/**
* @return the offset w.r.t. UTC in minutes. Returns 0 for unaware dates and for UTC dates.
*/
offset(): number;
/**
* @return The full year e.g. 2014
*/
year(): number;
/**
* @return The month 1-12 (note this deviates from JavaScript Date)
*/
month(): number;
/**
* @return The day of the month 1-31
*/
day(): number;
/**
* @return The hour 0-23
*/
hour(): number;
/**
* @return the minutes 0-59
*/
minute(): number;
/**
* @return the seconds 0-59
*/
second(): number;
/**
* @return the milliseconds 0-999
*/
millisecond(): number;
/**
* @return the day-of-week (the enum values correspond to JavaScript
* week day numbers)
*/
weekDay(): WeekDay;
/**
* Returns the day number within the year: Jan 1st has number 0,
* Jan 2nd has number 1 etc.
*
* @return the day-of-year [0-366]
*/
dayOfYear(): number;
/**
* The ISO 8601 week number. Week 1 is the week
* that has January 4th in it, and it starts on Monday.
* See https://en.wikipedia.org/wiki/ISO_week_date
*
* @return Week number [1-53]
*/
weekNumber(): number;
/**
* The week of this month. There is no official standard for this,
* but we assume the same rules for the weekNumber (i.e.
* week 1 is the week that has the 4th day of the month in it)
*
* @return Week number [1-5]
*/
weekOfMonth(): number;
/**
* Returns the number of seconds that have passed on the current day
* Does not consider leap seconds
*
* @return seconds [0-86399]
*/
secondOfDay(): number;
/**
* @return Milliseconds since 1970-01-01T00:00:00.000Z
*/
unixUtcMillis(): number;
/**
* @return The full year e.g. 2014
*/
utcYear(): number;
/**
* @return The UTC month 1-12 (note this deviates from JavaScript Date)
*/
utcMonth(): number;
/**
* @return The UTC day of the month 1-31
*/
utcDay(): number;
/**
* @return The UTC hour 0-23
*/
utcHour(): number;
/**
* @return The UTC minutes 0-59
*/
utcMinute(): number;
/**
* @return The UTC seconds 0-59
*/
utcSecond(): number;
/**
* Returns the UTC day number within the year: Jan 1st has number 0,
* Jan 2nd has number 1 etc.
*
* @return the day-of-year [0-366]
*/
utcDayOfYear(): number;
/**
* @return The UTC milliseconds 0-999
*/
utcMillisecond(): number;
/**
* @return the UTC day-of-week (the enum values correspond to JavaScript
* week day numbers)
*/
utcWeekDay(): WeekDay;
/**
* The ISO 8601 UTC week number. Week 1 is the week
* that has January 4th in it, and it starts on Monday.
* See https://en.wikipedia.org/wiki/ISO_week_date
*
* @return Week number [1-53]
*/
utcWeekNumber(): number;
/**
* The week of this month. There is no official standard for this,
* but we assume the same rules for the weekNumber (i.e.
* week 1 is the week that has the 4th day of the month in it)
*
* @return Week number [1-5]
*/
utcWeekOfMonth(): number;
/**
* Returns the number of seconds that have passed on the current day
* Does not consider leap seconds
*
* @return seconds [0-86399]
*/
utcSecondOfDay(): number;
/**
* Convert this date to the given time zone (in-place).
* Throws if this date does not have a time zone.
* @return this (for chaining)
*/
convert(zone?: TimeZone): DateTime;
/**
* Returns this date converted to the given time zone.
* Unaware dates can only be converted to unaware dates (clone)
* Converting an unaware date to an aware date throws an exception. Use the constructor
* if you really need to do that.
*
* @param zone The new time zone. This may be null to create unaware date.
* @return The converted date
*/
toZone(zone?: TimeZone): DateTime;
/**
* Convert to JavaScript date with the zone time in the getX() methods.
* Unless the timezone is local, the Date.getUTCX() methods will NOT be correct.
* This is because Date calculates getUTCX() from getX() applying local time zone.
*/
toDate(): Date;
/**
* Add a time duration relative to UTC.
* @return this + duration
*/
add(duration: Duration): DateTime;
/**
* Add an amount of time relative to UTC, as regularly as possible.
*
* Adding e.g. 1 hour will increment the utcHour() field, adding 1 month
* increments the utcMonth() field.
* Adding an amount of units leaves lower units intact. E.g.
* adding a month will leave the day() field untouched if possible.
*
* Note adding Months or Years will clamp the date to the end-of-month if
* the start date was at the end of a month, i.e. contrary to JavaScript
* Date#setUTCMonth() it will not overflow into the next month
*
* In case of DST changes, the utc time fields are still untouched but local
* time fields may shift.
*/
add(amount: number, unit: TimeUnit): DateTime;
/**
* Add an amount of time to the zone time, as regularly as possible.
*
* Adding e.g. 1 hour will increment the hour() field of the zone
* date by one. In case of DST changes, the time fields may additionally
* increase by the DST offset, if a non-existing local time would
* be reached otherwise.
*
* Adding a unit of time will leave lower-unit fields intact, unless the result
* would be a non-existing time. Then an extra DST offset is added.
*
* Note adding Months or Years will clamp the date to the end-of-month if
* the start date was at the end of a month, i.e. contrary to JavaScript
* Date#setUTCMonth() it will not overflow into the next month
*/
addLocal(duration: Duration): DateTime;
addLocal(amount: number, unit: TimeUnit): DateTime;
/**
* Same as add(-1*duration);
*/
sub(duration: Duration): DateTime;
/**
* Same as add(-1*amount, unit);
*/
sub(amount: number, unit: TimeUnit): DateTime;
/**
* Same as addLocal(-1*amount, unit);
*/
subLocal(duration: Duration): DateTime;
subLocal(amount: number, unit: TimeUnit): DateTime;
/**
* Time difference between two DateTimes
* @return this - other
*/
diff(other: DateTime): Duration;
/**
* Chops off the time part, yields the same date at 00:00:00.000
* @return a new DateTime
*/
startOfDay(): DateTime;
/**
* @return True iff (this < other)
*/
lessThan(other: DateTime): boolean;
/**
* @return True iff (this <= other)
*/
lessEqual(other: DateTime): boolean;
/**
* @return True iff this and other represent the same moment in time in UTC
*/
equals(other: DateTime): boolean;
/**
* @return True iff this and other represent the same time and the same zone
*/
identical(other: DateTime): boolean;
/**
* @return True iff this > other
*/
greaterThan(other: DateTime): boolean;
/**
* @return True iff this >= other
*/
greaterEqual(other: DateTime): boolean;
/**
* @return The minimum of this and other
*/
min(other: DateTime): DateTime;
/**
* @return The maximum of this and other
*/
max(other: DateTime): DateTime;
/**
* Proper ISO 8601 format string with any IANA zone converted to ISO offset
* E.g. "2014-01-01T23:15:33+01:00" for Europe/Amsterdam
*/
toIsoString(): string;
/**
* Return a string representation of the DateTime according to the
* specified format. The format is implemented as the LDML standard
* (http://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns)
*
* @param formatString The format specification (e.g. "dd/MM/yyyy HH:mm:ss")
* @return The string representation of this DateTime
*/
format(formatString: string): string;
/**
* Modified ISO 8601 format string with IANA name if applicable.
* E.g. "2014-01-01T23:15:33.000 Europe/Amsterdam"
*/
toString(): string;
/**
* Used by util.inspect()
*/
inspect(): string;
/**
* The valueOf() method returns the primitive value of the specified object.
*/
valueOf(): any;
/**
* Modified ISO 8601 format string in UTC without time zone info
*/
toUtcString(): string;
}
}
declare module '__timezonecomplete/duration' {
import basics = require("__timezonecomplete/basics");
import TimeUnit = basics.TimeUnit;
/**
* Construct a time duration
* @param n Number of years (may be fractional or negative)
* @return A duration of n years
*/
export function years(n: number): Duration;
/**
* Construct a time duration
* @param n Number of months (may be fractional or negative)
* @return A duration of n months
*/
export function months(n: number): Duration;
/**
* Construct a time duration
* @param n Number of days (may be fractional or negative)
* @return A duration of n days
*/
export function days(n: number): Duration;
/**
* Construct a time duration
* @param n Number of hours (may be fractional or negative)
* @return A duration of n hours
*/
export function hours(n: number): Duration;
/**
* Construct a time duration
* @param n Number of minutes (may be fractional or negative)
* @return A duration of n minutes
*/
export function minutes(n: number): Duration;
/**
* Construct a time duration
* @param n Number of seconds (may be fractional or negative)
* @return A duration of n seconds
*/
export function seconds(n: number): Duration;
/**
* Construct a time duration
* @param n Number of milliseconds (may be fractional or negative)
* @return A duration of n milliseconds
*/
export function milliseconds(n: number): Duration;
/**
* Time duration which is represented as an amount and a unit e.g.
* '1 Month' or '166 Seconds'. The unit is preserved through calculations.
*
* It has two sets of getter functions:
* - second(), minute(), hour() etc, singular form: these can be used to create string representations.
* These return a part of your string representation. E.g. for 2500 milliseconds, the millisecond() part would be 500
* - seconds(), minutes(), hours() etc, plural form: these return the total amount represented in the corresponding unit.
*/
export class Duration {
/**
* Construct a time duration
* @param n Number of years (may be fractional or negative)
* @return A duration of n years
*/
static years(n: number): Duration;
/**
* Construct a time duration
* @param n Number of months (may be fractional or negative)
* @return A duration of n months
*/
static months(n: number): Duration;
/**
* Construct a time duration
* @param n Number of days (may be fractional or negative)
* @return A duration of n days
*/
static days(n: number): Duration;
/**
* Construct a time duration
* @param n Number of hours (may be fractional or negative)
* @return A duration of n hours
*/
static hours(n: number): Duration;
/**
* Construct a time duration
* @param n Number of minutes (may be fractional or negative)
* @return A duration of n minutes
*/
static minutes(n: number): Duration;
/**
* Construct a time duration
* @param n Number of seconds (may be fractional or negative)
* @return A duration of n seconds
*/
static seconds(n: number): Duration;
/**
* Construct a time duration
* @param n Number of milliseconds (may be fractional or negative)
* @return A duration of n milliseconds
*/
static milliseconds(n: number): Duration;
/**
* Construct a time duration of 0
*/
constructor();
/**
* Construct a time duration from a string in one of two formats:
* 1) [-]hhhh[:mm[:ss[.nnn]]] e.g. '-01:00:30.501'
* 2) amount and unit e.g. '-1 days' or '1 year'. The unit may be in singular or plural form and is case-insensitive
*/
constructor(input: string);
/**
* Construct a duration from an amount and a time unit.
* @param amount Number of units
* @param unit A time unit i.e. TimeUnit.Second, TimeUnit.Hour etc. Default Millisecond.
*/
constructor(amount: number, unit?: TimeUnit);
/**
* @return another instance of Duration with the same value.
*/
clone(): Duration;
/**
* Returns this duration expressed in different unit (positive or negative, fractional).
* This is precise for Year <-> Month and for time-to-time conversion (i.e. Hour-or-less to Hour-or-less).
* It is approximate for any other conversion
*/
as(unit: TimeUnit): number;
/**
* Convert this duration to a Duration in another unit. You always get a clone even if you specify
* the same unit.
* This is precise for Year <-> Month and for time-to-time conversion (i.e. Hour-or-less to Hour-or-less).
* It is approximate for any other conversion
*/
convert(unit: TimeUnit): Duration;
/**
* The entire duration in milliseconds (negative or positive)
* For Day/Month/Year durations, this is approximate!
*/
milliseconds(): number;
/**
* The millisecond part of the duration (always positive)
* For Day/Month/Year durations, this is approximate!
* @return e.g. 400 for a -01:02:03.400 duration
*/
millisecond(): number;
/**
* The entire duration in seconds (negative or positive, fractional)
* For Day/Month/Year durations, this is approximate!
* @return e.g. 1.5 for a 1500 milliseconds duration
*/
seconds(): number;
/**
* The second part of the duration (always positive)
* For Day/Month/Year durations, this is approximate!
* @return e.g. 3 for a -01:02:03.400 duration
*/
second(): number;
/**
* The entire duration in minutes (negative or positive, fractional)
* For Day/Month/Year durations, this is approximate!
* @return e.g. 1.5 for a 90000 milliseconds duration
*/
minutes(): number;
/**
* The minute part of the duration (always positive)
* For Day/Month/Year durations, this is approximate!
* @return e.g. 2 for a -01:02:03.400 duration
*/
minute(): number;
/**
* The entire duration in hours (negative or positive, fractional)
* For Day/Month/Year durations, this is approximate!
* @return e.g. 1.5 for a 5400000 milliseconds duration
*/
hours(): number;
/**
* The hour part of a duration. This assumes that a day has 24 hours (which is not the case
* during DST changes).
*/
hour(): number;
/**
* DEPRECATED
* The hour part of the duration (always positive).
* Note that this part can exceed 23 hours, because for
* now, we do not have a days() function
* For Day/Month/Year durations, this is approximate!
* @return e.g. 25 for a -25:02:03.400 duration
*/
wholeHours(): number;
/**
* The entire duration in days (negative or positive, fractional)
* This is approximate if this duration is not in days!
*/
days(): number;
/**
* The day part of a duration. This assumes that a month has 30 days.
*/
day(): number;
/**
* The entire duration in days (negative or positive, fractional)
* This is approximate if this duration is not in Months or Years!
*/
months(): number;
/**
* The month part of a duration.
*/
month(): number;
/**
* The entire duration in years (negative or positive, fractional)
* This is approximate if this duration is not in Months or Years!
*/
years(): number;
/**
* Non-fractional positive years
*/
wholeYears(): number;
/**
* Amount of units (positive or negative, fractional)
*/
amount(): number;
/**
* The unit this duration was created with
*/
unit(): TimeUnit;
/**
* Sign
* @return "-" if the duration is negative
*/
sign(): string;
/**
* Approximate if the durations have units that cannot be converted
* @return True iff (this < other)
*/
lessThan(other: Duration): boolean;
/**
* Approximate if the durations have units that cannot be converted
* @return True iff (this <= other)
*/
lessEqual(other: Duration): boolean;
/**
* Similar but not identical
* Approximate if the durations have units that cannot be converted
* @return True iff this and other represent the same time duration
*/
equals(other: Duration): boolean;
/**
* Similar but not identical
* Returns false if we cannot determine whether they are equal in all time zones
* so e.g. 60 minutes equals 1 hour, but 24 hours do NOT equal 1 day
*
* @return True iff this and other represent the same time duration
*/
equalsExact(other: Duration): boolean;
/**
* Same unit and same amount
*/
identical(other: Duration): boolean;
/**
* Approximate if the durations have units that cannot be converted
* @return True iff this > other
*/
greaterThan(other: Duration): boolean;
/**
* Approximate if the durations have units that cannot be converted
* @return True iff this >= other
*/
greaterEqual(other: Duration): boolean;
/**