Date.html
43 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Date'>/**
</span> * @class Date
*
* Creates `Date` instances which let you work with dates and times.
*
* If you supply no arguments, the constructor creates a `Date` object for today's
* date and time according to local time. If you supply some arguments but not
* others, the missing arguments are set to 0. If you supply any arguments, you
* must supply at least the year, month, and day. You can omit the hours, minutes,
* seconds, and milliseconds.
*
* The date is measured in milliseconds since midnight 01 January, 1970 UTC. A day
* holds 86,400,000 milliseconds. The `Date` object range is -100,000,000 days to
* 100,000,000 days relative to 01 January, 1970 UTC.
*
* The `Date` object provides uniform behavior across platforms.
*
* The `Date` object supports a number of UTC (universal) methods, as well as
* local time methods. UTC, also known as Greenwich Mean Time (GMT), refers to the
* time as set by the World Time Standard. The local time is the time known to the
* computer where JavaScript is executed.
*
* Invoking `Date` in a non-constructor context (i.e., without the `new` operator)
* will return a string representing the current time.
*
* Note that `Date` objects can only be instantiated by calling `Date` or using it
* as a constructor; unlike other JavaScript object types, `Date` objects have no
* literal syntax.
*
* # Several ways to assign dates
*
* The following example shows several ways to assign dates:
*
* today = new Date();
* birthday = new Date("December 19, 1989 03:24:00");
* birthday = new Date(1989,11,19);
* birthday = new Date(1989,11,17,3,24,0);
*
* # Calculating elapsed time
*
* The following examples show how to determine the elapsed time between two dates:
*
* // using static methods
* var start = Date.now();
* // the event you'd like to time goes here:
* doSomethingForALongTime();
* var end = Date.now();
* var elapsed = end - start; // time in milliseconds
*
* // if you have Date objects
* var start = new Date();
* // the event you'd like to time goes here:
* doSomethingForALongTime();
* var end = new Date();
* var elapsed = end.getTime() - start.getTime(); // time in milliseconds
*
* // if you want to test a function and get back its return
* function printElapsedTime (fTest) {
* var nStartTime = Date.now(), vReturn = fTest(), nEndTime = Date.now();
* alert("Elapsed time: " + String(nEndTime - nStartTime) + "
* milliseconds");
* return vReturn;
* }
*
* yourFunctionReturn = printElapsedTime(yourFunction);
*
* # ISO 8601 formatted dates
*
* The following example shows how to formate a date in an ISO 8601 format using
* UTC:
*
* // use a function for the exact format desired...
* function ISODateString(d){
* function pad(n){return n<10 ? '0'+n : n}
* return d.getUTCFullYear()+'-'
* + pad(d.getUTCMonth()+1)+'-'
* + pad(d.getUTCDate())+'T'
* + pad(d.getUTCHours())+':'
* + pad(d.getUTCMinutes())+':'
* + pad(d.getUTCSeconds())+'Z'}
*
* var d = new Date();
* print(ISODateString(d)); // prints something like 2009-09-28T19:03:12Z
*
* <div class="notice">
* Documentation for this class comes from <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date">MDN</a>
* and is available under <a href="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons: Attribution-Sharealike license</a>.
* </div>
*/
<span id='Date-method-constructor'>/**
</span> * @method constructor
* Creates new Date object.
*
* @param {Number/String} [year]
* Either UNIX timestamp, date string, or year (when month and day parameters also provided):
*
* - Integer value representing the number of milliseconds since 1 January 1970
* 00:00:00 UTC (Unix Epoch).
*
* - String value representing a date. The string should be in a format recognized
* by the parse method (IETF-compliant RFC 1123 timestamps).
*
* - Integer value representing the year. For compatibility (in order to avoid the
* Y2K problem), you should always specify the year in full; use 1998, rather
* than 98.
*
* @param {Number} [month]
* Integer value representing the month, beginning with 0 for January to 11
* for December.
* @param {Number} [day]
* Integer value representing the day of the month (1-31).
* @param {Number} [hour]
* Integer value representing the hour of the day (0-23).
* @param {Number} [minute]
* Integer value representing the minute segment (0-59) of a time reading.
* @param {Number} [second]
* Integer value representing the second segment (0-59) of a time reading.
* @param {Number} [millisecond]
* Integer value representing the millisecond segment (0-999) of a time reading.
*/
//Methods
<span id='Date-static-method-now'>/**
</span> * @method now
* @static
* Returns the numeric value corresponding to the current time.
*
* The `now` method returns the milliseconds elapsed since 1 January 1970 00:00:00 UTC up until now as
* a number.
*
* When using `now` to create timestamps or unique IDs, keep in mind that the resolution may be 15
* milliseconds on Windows, so you could end up with several equal values if `now` is called multiple
* times within a short time span.
*
* @return {Number} Returns the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC.
*/
<span id='Date-static-method-parse'>/**
</span> * @method parse
* @static
* Parses a string representation of a date, and returns the number of milliseconds
* since January 1, 1970, 00:00:00, local time.
*
* The `parse` method takes a date string (such as `"Dec 25, 1995"`) and returns the number of
* milliseconds since January 1, 1970, 00:00:00 UTC. The local time zone is used to interpret
* arguments that do not contain time zone information. This function is useful for setting date
* values based on string values, for example in conjunction with the `setTime` method and the
* {@link Date} object.
*
* Given a string representing a time, parse returns the time value. It accepts the IETF standard (RFC
* 1123 Section 5.2.14 and elsewhere) date syntax: `"Mon, 25 Dec 1995 13:30:00 GMT"`. It understands
* the continental US time-zone abbreviations, but for general use, use a time-zone offset, for
* example, `"Mon, 25 Dec 1995 13:30:00 GMT+0430"` (4 hours, 30 minutes east of the Greenwich
* meridian). If you do not specify a time zone, the local time zone is assumed. GMT and UTC are
* considered equivalent.
*
* ### Using parse
*
* If `IPOdate` is an existing `Date` object, then you can set it to August 9, 1995 (local time) as
* follows:
*
* IPOdate.setTime(Date.parse("Aug 9, 1995"));
*
* Some other examples:
*
* // Returns 807937200000 in time zone GMT-0300, and other values in other
* // timezones, since the argument does not specify a time zone.
* Date.parse("Aug 9, 1995");
*
* // Returns 807926400000 no matter the local time zone.
* Date.parse("Wed, 09 Aug 1995 00:00:00 GMT");
*
* // Returns 807937200000 in timezone GMT-0300, and other values in other
* // timezones, since there is no time zone specifier in the argument.
* Date.parse("Wed, 09 Aug 1995 00:00:00");
*
* // Returns 0 no matter the local time zone.
* Date.parse("Thu, 01 Jan 1970 00:00:00 GMT");
*
* // Returns 14400000 in timezone GMT-0400, and other values in other
* // timezones, since there is no time zone specifier in the argument.
* Date.parse("Thu, 01 Jan 1970 00:00:00");
*
* // Returns 14400000 no matter the local time zone.
* Date.parse("Thu, 01 Jan 1970 00:00:00 GMT-0400");
*
* @param {String} dateString A string representing a date.
* @return {Number} Number of milliseconds since January 1, 1970, 00:00:00, local time.
*/
<span id='Date-static-method-UTC'>/**
</span> * @method UTC
* @static
* Accepts the same parameters as the longest form of the constructor, and returns
* the number of milliseconds in a `Date` object since January 1, 1970, 00:00:00,
* universal time.
*
* `UTC` takes comma-delimited date parameters and returns the number of milliseconds between January
* 1, 1970, 00:00:00, universal time and the time you specified.
*
* You should specify a full year for the year; for example, 1998. If a year between 0 and 99 is
* specified, the method converts the year to a year in the 20th century (1900 + year); for example,
* if you specify 95, the year 1995 is used.
*
* The `UTC` method differs from the `Date` constructor in two ways.
* * `Date.UTC` uses universal time instead of the local time.
* * `Date.UTC` returns a time value as a number instead of creating a `Date` object.
*
* If a parameter you specify is outside of the expected range, the `UTC` method updates the other
* parameters to allow for your number. For example, if you use 15 for month, the year will be
* incremented by 1 (year + 1), and 3 will be used for the month.
*
* Because `UTC` is a static method of `Date`, you always use it as `Date.UTC()`, rather than as a
* method of a `Date` object you created.
*
* The following statement creates a `Date` object using GMT instead of local time:
*
* gmtDate = new Date(Date.UTC(96, 11, 1, 0, 0, 0));
*
* @param {Number} year A year after 1900.
* @param {Number} month An integer between 0 and 11 representing the month.
* @param {Number} date An integer between 1 and 31 representing the day of the month.
* @param {Number} hrs An integer between 0 and 23 representing the hours.
* @param {Number} min An integer between 0 and 59 representing the minutes.
* @param {Number} sec An integer between 0 and 59 representing the seconds.
* @param {Number} ms An integer between 0 and 999 representing the milliseconds.
* @return {Number} Number of milliseconds since January 1, 1970, 00:00:00, universal time.
*/
//Methods
<span id='Date-method-getDate'>/**
</span> * @method getDate
* Returns the numeric value corresponding to the current time.
*
* The second statement below assigns the value 25 to the variable `day`, based on the value of the
* `Date` object `Xmas95`.
*
* Xmas95 = new Date("December 25, 1995 23:15:00")
* day = Xmas95.getDate()
*
* @return {Number} Value between 1 and 31.
*/
<span id='Date-method-getDay'>/**
</span> * @method getDay
* Returns the numeric value corresponding to the current time.
*
* The value returned by `getDay` is an integer corresponding to the day of the week: 0 for Sunday, 1
* for Monday, 2 for Tuesday, and so on.
*
* The second statement below assigns the value 1 to `weekday`, based on the value of the `Date`
* object `Xmas95`. December 25, 1995, is a Monday.
*
* Xmas95 = new Date("December 25, 1995 23:15:00");
* weekday = Xmas95.getDay();
*
* @return {Number} A numeric representation of the day from Sunday (0) to
* Saturday (6).
*/
<span id='Date-method-getFullYear'>/**
</span> * @method getFullYear
* Returns the numeric value corresponding to the current time.
*
* The value returned by `getFullYear` is an absolute number. For dates between the years 1000 and
* 9999, `getFullYear` returns a four-digit number, for example, 1995. Use this function to make sure
* a year is compliant with years after 2000.
*
* Use this method instead of the `getYear` method.
*
* The following example assigns the four-digit value of the current year to the variable yr.
*
* var today = new Date();
* var yr = today.getFullYear();
*
* @return {Number} Four digit representation of the year.
*/
<span id='Date-method-getHours'>/**
</span> * @method getHours
* Returns the numeric value corresponding to the current time.
*
* The second statement below assigns the value 23 to the variable `hours`, based on the value of the
* `Date` object `Xmas95`.
*
* Xmas95 = new Date("December 25, 1995 23:15:00")
* hours = Xmas95.getHours()
*
* @return {Number} Value between 0 and 23, using 24-hour clock.
*/
<span id='Date-method-getMilliseconds'>/**
</span> * @method getMilliseconds
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the milliseconds portion of the current time to the variable ms.
*
* var ms;
* Today = new Date();
* ms = Today.getMilliseconds();
*
* @return {Number} A number between 0 and 999.
*/
<span id='Date-method-getMinutes'>/**
</span> * @method getMinutes
* Returns the numeric value corresponding to the current time.
*
* The second statement below assigns the value 15 to the variable `minutes`, based on the value of
* the `Date` object `Xmas95`.
*
* Xmas95 = new Date("December 25, 1995 23:15:00")
* minutes = Xmas95.getMinutes()
*
* @return {Number} Value between 0 and 59.
*/
<span id='Date-method-getMonth'>/**
</span> * @method getMonth
* Returns the numeric value corresponding to the current time.
*
* The second statement below assigns the value 11 to the variable `month`, based on the value of the
* `Date` object `Xmas95`.
*
* Xmas95 = new Date("December 25, 1995 23:15:00")
* month = Xmas95.getMonth()
*
* @return {Number} An integer between 0 and 11. 0 corresponds to January, 1 to February, and so on.
*/
<span id='Date-method-getSeconds'>/**
</span> * @method getSeconds
* Returns the numeric value corresponding to the current time.
*
* The second statement below assigns the value 30 to the variable `secs`, based on the value of the
* `Date` object `Xmas95`.
*
* Xmas95 = new Date("December 25, 1995 23:15:30")
* secs = Xmas95.getSeconds()
*
* @return {Number} Value between 0 and 59.
*/
<span id='Date-method-getTime'>/**
</span> * @method getTime
* Returns the numeric value corresponding to the current time.
*
* The value returned by the `getTime` method is the number of milliseconds since 1 January 1970
* 00:00:00 UTC. You can use this method to help assign a date and time to another `Date` object.
*
* This method is functionally equivalent to the `valueOf` method.
*
* Using getTime for copying dates
*
* Constructing a date object with the identical time value.
*
* var birthday = new Date(1994, 12, 10);
* var copy = new Date();
* copy.setTime(birthday.getTime());
*
* Measuring execution time
*
* Subtracting two subsequent getTime calls on newly generated Date objects, give the time span
* between these two calls. This can be used to calculate the executing time of some operations.
*
* var end, start;
*
* start = new Date();
* for (var i = 0; i < 1000; i++)
* Math.sqrt(i);
* end = new Date();
*
* console.log("Operation took " + (end.getTime() - start.getTime()) + " msec");
*
* @return {Number} Number of milliseconds since 1/1/1970 (GMT).
*/
<span id='Date-method-getTimezoneOffset'>/**
</span> * @method getTimezoneOffset
* Returns the numeric value corresponding to the current time.
*
* The time-zone offset is the difference, in minutes, between UTC and local time. Note that this
* means that the offset is positive if the local timezone is behind UTC and negative if it is ahead.
* For example, if your time zone is UTC+10 (Australian Eastern Standard Time), -600 will be returned.
* Daylight savings time prevents this value from being a constant even for a given locale
*
* x = new Date()
* currentTimeZoneOffsetInHours = x.getTimezoneOffset()/60
*
* @return {Number} Minutes between GMT and local time.
*/
<span id='Date-method-getUTCDate'>/**
</span> * @method getUTCDate
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the day portion of the current date to the variable `d`.
*
* var d;
* Today = new Date();
* d = Today.getUTCDate();
*
* @return {Number} Integer between 1 and 31 representing the day.
*/
<span id='Date-method-getUTCDay'>/**
</span> * @method getUTCDay
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the weekday portion of the current date to the variable `weekday`.
*
* var weekday;
* Today = new Date()
* weekday = Today.getUTCDay()
*
* @return {Number} A numeric representation of the day from Sunday (0) to
* Saturday (6).
*/
<span id='Date-method-getUTCFullYear'>/**
</span> * @method getUTCFullYear
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the four-digit value of the current year to the variable `yr`.
*
* var yr;
* Today = new Date();
* yr = Today.getUTCFullYear();
*
* @return {Number} Four digit representation of the year.
*/
<span id='Date-method-getUTCHours'>/**
</span> * @method getUTCHours
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the hours portion of the current time to the variable `hrs`.
*
* var hrs;
* Today = new Date();
* hrs = Today.getUTCHours();
*
* @return {Number} Value between 0 and 23.
*/
<span id='Date-method-getUTCMilliseconds'>/**
</span> * @method getUTCMilliseconds
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the milliseconds portion of the current time to the variable `ms`.
*
* var ms;
* Today = new Date();
* ms = Today.getUTCMilliseconds();
*
* @return {Number} Milliseconds portion of the Date.
*/
<span id='Date-method-getUTCMinutes'>/**
</span> * @method getUTCMinutes
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the minutes portion of the current time to the variable `min`.
*
* var min;
* Today = new Date();
* min = Today.getUTCMinutes();
*
* @return {Number} Value between 0 and 59.
*/
<span id='Date-method-getUTCMonth'>/**
</span> * @method getUTCMonth
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the month portion of the current date to the variable `mon`.
*
* var mon;
* Today = new Date();
* mon = Today.getUTCMonth();
*
* @return {Number} Value between 0 (January) and 11 (December).
*/
<span id='Date-method-getUTCSeconds'>/**
</span> * @method getUTCSeconds
* Returns the numeric value corresponding to the current time.
*
* The following example assigns the seconds portion of the current time to the variable `sec`.
*
* var sec;
* Today = new Date();
* sec = Today.getUTCSeconds();
*
* @return {Number} Value between 0 and 59.
*/
<span id='Date-method-setDate'>/**
</span> * @method setDate
* Sets the day of the month (1-31) for a specified date according to local time.
*
* If the parameter you specify is outside of the expected range, `setDate` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 0 for `dayValue`, the
* date will be set to the last day of the previous month.
*
* The second statement below changes the day for theBigDay to July 24 from its original value.
*
* theBigDay = new Date("July 27, 1962 23:30:00")
* theBigDay.setDate(24)
*
* @param {Number} dayValue An integer from 1 to 31, representing the day of the month.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setFullYear'>/**
</span> * @method setFullYear
* Sets the full year (4 digits for 4-digit years) for a specified date according to
* local time.
*
* If you do not specify the `monthValue` and `dayValue` parameters, the values returned from the
* `getMonth` and `getDate` methods are used.
*
* If a parameter you specify is outside of the expected range, `setFullYear` attempts to update the
* other parameters and the date information in the `Date` object accordingly. For example, if you
* specify 15 for monthValue, the year is incremented by 1 (year + 1), and 3 is used for the month.
*
* theBigDay = new Date();
* theBigDay.setFullYear(1997);
*
* @param {Number} yearValue An integer specifying the numeric value of the year, for example, 1995.
* @param {Number} monthValue An integer between 0 and 11 representing the months January through
* December.
* @param {Number} dayValue An integer between 1 and 31 representing the day of the month. If you
* specify the `dayValue` parameter, you must also specify the `monthValue`.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setHours'>/**
</span> * @method setHours
* Sets the hours (0-23) for a specified date according to local time.
*
* If you do not specify the `minutesValue`, `secondsValue`, and `msValue` parameters, the values
* returned from the `getUTCMinutes`, `getUTCSeconds`, and `getMilliseconds` methods are used.
*
* If a parameter you specify is outside of the expected range, setHours attempts to update the date
* information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`, the
* minutes will be incremented by 1 (min + 1), and 40 will be used for seconds.
*
* theBigDay.setHours(7)
*
* @param {Number} hoursValue An integer between 0 and 23, representing the hour.
* @param {Number} minutesValue An integer between 0 and 59, representing the minutes.
* @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you specify the
* `secondsValue` parameter, you must also specify the `minutesValue`.
* @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify the
* `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setMilliseconds'>/**
</span> * @method setMilliseconds
* Sets the milliseconds (0-999) for a specified date according to local time.
*
* If you specify a number outside the expected range, the date information in the `Date` object is
* updated accordingly. For example, if you specify 1005, the number of seconds is incremented by 1,
* and 5 is used for the milliseconds.
*
* theBigDay = new Date();
* theBigDay.setMilliseconds(100);
*
* @param {Number} millisecondsValue A number between 0 and 999, representing the milliseconds.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setMinutes'>/**
</span> * @method setMinutes
* Sets the minutes (0-59) for a specified date according to local time.
*
* If you do not specify the `secondsValue` and `msValue` parameters, the values returned from
* `getSeconds` and `getMilliseconds` methods are used.
*
* If a parameter you specify is outside of the expected range, `setMinutes` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`,
* the minutes (`minutesValue`) will be incremented by 1 (minutesValue + 1), and 40 will be used for
* seconds.
*
* theBigDay.setMinutes(45)
*
* @param {Number} minutesValue An integer between 0 and 59, representing the minutes.
* @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you
* specify the secondsValue parameter, you must also specify the `minutesValue`.
* @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify
* the `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setMonth'>/**
</span> * @method setMonth
* Sets the month (0-11) for a specified date according to local time.
*
* If you do not specify the `dayValue` parameter, the value returned from the `getDate` method is
* used.
*
* If a parameter you specify is outside of the expected range, `setMonth` attempts to update the date
* information in the `Date` object accordingly. For example, if you use 15 for `monthValue`, the year
* will be incremented by 1 (year + 1), and 3 will be used for month.
*
* theBigDay.setMonth(6)
*
* @param {Number} monthValue An integer between 0 and 11 (representing the months January through
* December).
* @param {Number} dayValue An integer from 1 to 31, representing the day of the month.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setSeconds'>/**
</span> * @method setSeconds
* Sets the seconds (0-59) for a specified date according to local time.
*
* If you do not specify the `msValue` parameter, the value returned from the `getMilliseconds` method
* is used.
*
* If a parameter you specify is outside of the expected range, `setSeconds` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`,
* the minutes stored in the `Date` object will be incremented by 1, and 40 will be used for seconds.
*
* theBigDay.setSeconds(30)
*
* @param {Number} secondsValue An integer between 0 and 59.
* @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify
* the`msValue` parameter, you must also specify the `minutesValue` and `secondsValue`.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setTime'>/**
</span> * @method setTime
* Sets the Date object to the time represented by a number of milliseconds since
* January 1, 1970, 00:00:00 UTC, allowing for negative numbers for times prior.
*
* Use the `setTime` method to help assign a date and time to another `Date` object.
*
* theBigDay = new Date("July 1, 1999")
* sameAsBigDay = new Date()
* sameAsBigDay.setTime(theBigDay.getTime())
*
* @param {Number} timeValue An integer representing the number of milliseconds since 1 January
* 1970, 00:00:00 UTC.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setUTCDate'>/**
</span> * @method setUTCDate
* Sets the day of the month (1-31) for a specified date according to universal time.
*
* If a parameter you specify is outside of the expected range, `setUTCDate` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 40 for `dayValue`, and
* the month stored in the `Date` object is June, the day will be changed to 10 and the month will be
* incremented to July.
*
* theBigDay = new Date();
* theBigDay.setUTCDate(20);
*
* @param {Number} dayValue An integer from 1 to 31, representing the day of the month.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setUTCFullYear'>/**
</span> * @method setUTCFullYear
* Sets the full year (4 digits for 4-digit years) for a specified date according
* to universal time.
*
* If you do not specify the `monthValue` and `dayValue` parameters, the values returned from the
* `getMonth` and `getDate` methods are used.
*
* If a parameter you specify is outside of the expected range, `setUTCFullYear` attempts to update
* the other parameters and the date information in the `Date` object accordingly. For example, if you
* specify 15 for `monthValue`, the year is incremented by 1 (year + 1), and 3 is used for the month.
*
* theBigDay = new Date();
* theBigDay.setUTCFullYear(1997);
*
* @param {Number} yearValue An integer specifying the numeric value of the year, for example, 1995.
* @param {Number} monthValue An integer between 0 and 11 representing the months January through
* December.
* @param {Number} dayValue An integer between 1 and 31 representing the day of the month. If you
* specify the `dayValue` parameter, you must also specify the `monthValue`.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setUTCHours'>/**
</span> * @method setUTCHours
* Sets the hour (0-23) for a specified date according to universal time.
*
* If you do not specify the `minutesValue`, `secondsValue`, and `msValue` parameters, the values
* returned from the `getUTCMinutes`, `getUTCSeconds`, and `getUTCMilliseconds` methods are used.
*
* If a parameter you specify is outside of the expected range, `setUTCHours` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`,
* the minutes will be incremented by 1 (min + 1), and 40 will be used for seconds.
*
* theBigDay = new Date();
* theBigDay.setUTCHours(8);
*
* @param {Number} hoursValue An integer between 0 and 23, representing the hour.
* @param {Number} minutesValue An integer between 0 and 59, representing the minutes.
* @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you specify the
* `secondsValue` parameter, you must also specify the `minutesValue`.
* @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify the
* `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setUTCMilliseconds'>/**
</span> * @method setUTCMilliseconds
* Sets the milliseconds (0-999) for a specified date according to universal time.
*
* If a parameter you specify is outside of the expected range, `setUTCMilliseconds` attempts to
* update the date information in the `Date` object accordingly. For example, if you use 1100 for
* `millisecondsValue`, the seconds stored in the Date object will be incremented by 1, and 100 will
* be used for milliseconds.
*
* theBigDay = new Date();
* theBigDay.setUTCMilliseconds(500);
*
* @param {Number} millisecondsValue A number between 0 and 999, representing the milliseconds.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setUTCMinutes'>/**
</span> * @method setUTCMinutes
* Sets the minutes (0-59) for a specified date according to universal time.
*
* If you do not specify the `secondsValue` and `msValue` parameters, the values returned from
* `getUTCSeconds` and `getUTCMilliseconds` methods are used.
*
* If a parameter you specify is outside of the expected range, `setUTCMinutes` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`,
* the minutes (`minutesValue`) will be incremented by 1 (`minutesValue` + 1), and 40 will be used for
* seconds.
*
* theBigDay = new Date();
* theBigDay.setUTCMinutes(43);
*
* @param {Number} minutesValue An integer between 0 and 59, representing the minutes.
* @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you specify the `secondsValue` parameter, you must also specify the `minutesValue`.
* @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify the `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setUTCMonth'>/**
</span> * @method setUTCMonth
* Sets the month (0-11) for a specified date according to universal time.
*
* If you do not specify the `dayValue` parameter, the value returned from the `getUTCDate` method is
* used.
*
* If a parameter you specify is outside of the expected range, `setUTCMonth` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 15 for `monthValue`, the
* year will be incremented by 1 (year + 1), and 3 will be used for month.
*
* theBigDay = new Date();
* theBigDay.setUTCMonth(11);
*
* @param {Number} monthValue An integer between 0 and 11, representing the months January through
* December.
* @param {Number} dayValue An integer from 1 to 31, representing the day of the month.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-setUTCSeconds'>/**
</span> * @method setUTCSeconds
* Sets the seconds (0-59) for a specified date according to universal time.
*
* If you do not specify the `msValue` parameter, the value returned from the `getUTCMilliseconds`
* methods is used.
*
* If a parameter you specify is outside of the expected range, `setUTCSeconds` attempts to update the
* date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`,
* the minutes stored in the `Date` object will be incremented by 1, and 40 will be used for seconds.
*
* theBigDay = new Date();
* theBigDay.setUTCSeconds(20);
*
* @param {Number} secondsValue An integer between 0 and 59.
* @param {Number} msValue A number between 0 and 999, representing the milliseconds.
* @return {Number} New date represented as milliseconds.
*/
<span id='Date-method-toDateString'>/**
</span> * @method toDateString
* Returns the "date" portion of the Date as a human-readable string in American English.
*
* {@link Date} instances refer to a specific point in time. Calling `toString` will return the
* date formatted in a human readable form in American English. In SpiderMonkey, this consists of the
* date portion (day, month, and year) followed by the time portion (hours, minutes, seconds, and time
* zone). Sometimes it is desirable to obtain a string of the date portion; such a thing can be
* accomplished with the `toDateString` method.
*
* The `toDateString` method is especially useful because compliant engines implementing ECMA-262 may
* differ in the string obtained from `toString` for `Date` objects, as the format is implementation-
* dependent and simple string slicing approaches may not produce consistent results across multiple
* engines.
*
* var d = new Date(1993, 6, 28, 14, 39, 7);
* println(d.toString()); // prints Wed Jul 28 1993 14:39:07 GMT-0600 (PDT)
* println(d.toDateString()); // prints Wed Jul 28 1993
*
* @return {String} Human-readable string, in local time.
*/
<span id='Date-method-toLocaleDateString'>/**
</span> * @method toLocaleDateString
* Returns the "date" portion of the Date as a string, using the current locale's
* conventions.
*
* The `toLocaleDateString` method relies on the underlying operating system in formatting dates. It
* converts the date to a string using the formatting convention of the operating system where the
* script is running. For example, in the United States, the month appears before the date (04/15/98),
* whereas in Germany the date appears before the month (15.04.98). If the operating system is not
* year-2000 compliant and does not use the full year for years before 1900 or over 2000,
* `toLocaleDateString` returns a string that is not year-2000 compliant. `toLocaleDateString` behaves
* similarly to `toString` when converting a year that the operating system does not properly format.
*
* Methods such as `getDate`, `getMonth`, and `getFullYear` give more portable results than
* `toLocaleDateString`. Use `toLocaleDateString` when the intent is to display to the user a string
* formatted using the regional format chosen by the user. Be aware that this method, due to its
* nature, behaves differently depending on the operating system and on the user's settings.
*
* In the following example, `today` is a `Date` object:
*
* today = new Date(95,11,18,17,28,35) //months are represented by 0 to 11
* today.toLocaleDateString()
*
* In this example, `toLocaleDateString` returns a string value that is similar to the following form.
* The exact format depends on the platform, locale and user's settings.
*
* 12/18/95
*
* You shouldn't use this method in contexts where you rely on a particular format or locale.
*
* "Last visit: " + someDate.toLocaleDateString(); // Good example
* "Last visit was at " + someDate.toLocaleDateString(); // Bad example
*
* @return {String} Human-readable string that may be formatted differently depending
* on the country.
*/
<span id='Date-method-toLocaleString'>/**
</span> * @method toLocaleString
* Converts a date to a string, using the current locale's conventions. Overrides
* the `Object.toLocaleString` method.
*
* The `toLocaleString` method relies on the underlying operating system in formatting dates. It
* converts the date to a string using the formatting convention of the operating system where the
* script is running. For example, in the United States, the month appears before the date (04/15/98),
* whereas in Germany the date appears before the month (15.04.98). If the operating system is not
* year-2000 compliant and does not use the full year for years before 1900 or over 2000,
* `toLocaleString` returns a string that is not year-2000 compliant. `toLocaleString` behaves
* similarly to `toString` when converting a year that the operating system does not properly format.
*
* Methods such as `getDate`, `getMonth`, `getFullYear`, `getHours`, `getMinutes`, and `getSeconds`
* give more portable results than `toLocaleString`. Use `toLocaleString` when the intent is to
* display to the user a string formatted using the regional format chosen by the user. Be aware that
* this method, due to its nature, behaves differently depending on the operating system and on the
* user's settings.
*
* In the following example, `today` is a `Date` object:
*
* today = new Date(95,11,18,17,28,35); //months are represented by 0 to 11
* today.toLocaleString();
*
* In this example, `toLocaleString` returns a string value that is similar to the following form. The
* exact format depends on the platform, locale and user's settings.
*
* 12/18/95 17:28:35
*
* You shouldn't use this method in contexts where you rely on a particular format or locale.
*
* "Last visit: " + someDate.toLocaleString(); // Good example
* "Last visit was at " + someDate.toLocaleString(); // Bad example
*
* @return {String} Human-readable string that may be formatted differently depending
* on the country.
*/
<span id='Date-method-toLocaleTimeString'>/**
</span> * @method toLocaleTimeString
* Returns the "time" portion of the Date as a string, using the current locale's
* conventions.
*
* The `toLocaleTimeString` method relies on the underlying operating system in formatting dates. It
* converts the date to a string using the formatting convention of the operating system where the
* script is running. For example, in the United States, the month appears before the date (04/15/98),
* whereas in Germany the date appears before the month (15.04.98).
*
* Methods such as `getHours`, `getMinutes`, and `getSeconds` give more consistent results than
* `toLocaleTimeString`. Use `toLocaleTimeString` when the intent is to display to the user a string
* formatted using the regional format chosen by the user. Be aware that this method, due to its
* nature, behaves differently depending on the operating system and on the user's settings.
*
* In the following example, `today` is a `Date` object:
*
* today = new Date(95,11,18,17,28,35) //months are represented by 0 to 11
* today.toLocaleTimeString()
*
* In this example, `toLocaleTimeString` returns a string value that is similar to the following form.
* The exact format depends on the platform.
*
* 17:28:35
*
* You shouldn't use this method in contexts where you rely on a particular format or locale.
*
* "Last visit: " + someDate.toLocaleTimeString(); // Good example
* "Last visit was at " + someDate.toLocaleTimeString(); // Bad example
*
* @return {String} Human-readable string that may be formatted differently depending
* on the country.
*/
<span id='Date-method-toString'>/**
</span> * @method toString
* Returns a string representing the specified Date object. Overrides the
* `Object.prototype.toString` method.
*
* The `Date` object overrides the toString method of the Object object; it does not inherit
* `Object.toString`. For `Date` objects, the `toString` method returns a string representation of the
* object.
*
* `toString` always returns a string representation of the date in American English.
*
* JavaScript calls the `toString` method automatically when a date is to be represented as a text
* value or when a date is referred to in a string concatenation.
*
* The following assigns the `toString` value of a `Date` object to `myVar`:
*
* x = new Date();
* myVar=x.toString(); //assigns a value to myVar similar to:
* //Mon Sep 28 1998 14:36:22 GMT-0700 (Pacific Daylight Time)
*
* @return {String} Human-readable string of the date in local time.
*/
<span id='Date-method-toTimeString'>/**
</span> * @method toTimeString
* Returns the "time" portion of the Date as a human-readable string.
*
* {@link Date} instances refer to a specific point in time. Calling `toString` will return the
* date formatted in a human readable form in American English. In SpiderMonkey, this consists of the
* date portion (day, month, and year) followed by the time portion (hours, minutes, seconds, and
* time zone). Sometimes it is desirable to obtain a string of the time portion; such a thing can be
* accomplished with the `toTimeString` method.
*
* The `toTimeString` method is especially useful because compliant engines implementing ECMA-262 may
* differ in the string obtained from `toString` for `Date` objects, as the format is implementation-
* dependent; simple string slicing approaches may not produce consistent results across multiple
* engines.
*
* var d = new Date(1993, 6, 28, 14, 39, 7);
* println(d.toString()); // prints Wed Jul 28 1993 14:39:07 GMT-0600 (PDT)
* println(d.toTimeString()); // prints 14:39:07 GMT-0600 (PDT)
*
* @return {String} Human-readable string of the date in local time.
*/
<span id='Date-method-toUTCString'>/**
</span> * @method toUTCString
* Converts a date to a string, using the universal time convention.
*
* The value returned by `toUTCString` is a readable string in American English in the UTC time zone.
* The format of the return value may vary according to the platform.
*
* var today = new Date();
* var UTCstring = today.toUTCString();
* // Mon, 03 Jul 2006 21:44:38 GMT
*
* @return {String} String of the date in UTC.
*/
<span id='Date-method-valueOf'>/**
</span> * @method valueOf
* Returns the primitive value of a Date object. Overrides the
* Object.prototype.valueOf method.
*
* The `valueOf` method returns the primitive value of a `Date` object as a number data type, the
* number of milliseconds since midnight 01 January, 1970 UTC.
*
* This method is functionally equivalent to the `getTime` method.
*
* This method is usually called internally by JavaScript and not explicitly in code.
*
* x = new Date(56, 6, 17);
* myVar = x.valueOf(); //assigns -424713600000 to myVar
*
* @return {Number} Date represented as milliseconds.
*/</pre>
</body>
</html>