[datejs commit] r174 - wiki
codesite...@google.com
Date: Fri Apr 25 14:08:14 2008
New Revision: 174
Modified:
wiki/APIDocumentation.wiki
Log:
Modified: wiki/APIDocumentation.wiki
==============================================================================
--- wiki/APIDocumentation.wiki (original)
+++ wiki/APIDocumentation.wiki Fri Apr 25 14:08:14 2008
@@ -1,7 +1,7 @@
#summary Date class and instance methods provided by the Datejs library.
#labels Featured
-= Public Static Methods =
+=Public Static Methods=
----
==http://www.datejs.com/images/function.gif Date.today==
@@ -164,7 +164,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif
Date.getTimezoneAbbreviation ( `Number` timezoneOffset, `Boolean`
isDayLightSavingsTime ) : `String`==
+==http://www.datejs.com/images/function.gif Date.getTimezoneAbbreviation==
+ ===Date.getTimezoneAbbreviation ( `Number` timezoneOffset, `Boolean`
isDayLightSavingsTime ) : `String`===
Returns a [CultureInfo culture-specific] timezone abbreviation based
on a given offset and a boolean indicating whether daylight savings
time is in effect.
@@ -184,7 +185,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.getTimezoneOffset (
`String` timezoneAbbreviation, `Boolean` isDayLightSavingsTime ) : `Number`==
+==http://www.datejs.com/images/function.gif Date.getTimezoneOffset==
+ ===Date.getTimezoneOffset ( `String` timezoneAbbreviation, `Boolean`
isDayLightSavingsTime ) : `Number`===
Gets the timezone offset if given a [CultureInfo culture-specific]
string which is a valid full or abbreviated timezone name and a boolean
indicating whether daylight savings time is in effect.
@@ -203,7 +205,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.parse ( `String`
dateString ) : `Date`==
+==http://www.datejs.com/images/function.gif Date.parse==
+ ===Date.parse ( `String` dateString ) : `Date`===
Converts the specified string value into its !JavaScript Date
equivalent using [CultureInfo culture-specific] format information.
@@ -225,7 +228,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.parseExact ( `String`
dateString, `String` formatStringOrArray ) : `Date`==
+==http://www.datejs.com/images/function.gif Date.parseExact==
+ ===Date.parseExact ( `String` dateString, `String`
formatStringOrArray ) : `Date`===
Converts the specified string value into its !JavaScript Date
equivalent using the specified format (string) or formats (array). The
format of the string value must match one of the supplied formats exactly.
@@ -247,7 +251,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.validateDay (
`Number` day, `Number` fullYear, `Number` monthNumber ) : `Boolean`==
+==http://www.datejs.com/images/function.gif Date.validateDay==
+ ===Date.validateDay ( `Number` day, `Number` fullYear, `Number`
monthNumber ) : `Boolean`===
Validates the number is within an acceptable range for the days in a
month [0-MaxDaysInMonth].
@@ -268,7 +273,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.validateHour (
`Number` hour ) : `Boolean`==
+==http://www.datejs.com/images/function.gif Date.validateHour==
+ ===Date.validateHour ( `Number` hour ) : `Boolean`===
Validates the number is within an acceptable range for hours [0-23].
Returns true if within range, otherwise false.
@@ -287,7 +293,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.validateMillisecond (
`Number` milliseconds ) : `Boolean`==
+==http://www.datejs.com/images/function.gif Date.validateMillisecond==
+ ===Date.validateMillisecond ( `Number` milliseconds ) : `Boolean`===
Validates the number is within an acceptable range for milliseconds
[0-999]. Returns true if within range, otherwise false.
@@ -305,7 +312,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.validateMinute (
`Number` minutes ) : `Boolean`==
+==http://www.datejs.com/images/function.gif Date.validateMinute==
+ ===Date.validateMinute ( `Number` minutes ) : `Boolean`===
Validates the number is within an acceptable range for minutes
[0-59]. Returns true if within range, otherwise false.
@@ -324,7 +332,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.validateMonth (
`Number` month ) : `Boolean`==
+==http://www.datejs.com/images/function.gif Date.validateMonth==
+ ===Date.validateMonth ( `Number` month ) : `Boolean`===
Validates the number is within an acceptable range for months [0-11].
@@ -343,7 +352,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.validateSecond (
`Number` second ) : `Boolean`==
+==http://www.datejs.com/images/function.gif Date.validateSecond==
+ ===Date.validateSecond ( `Number` second ) : `Boolean`===
Validates the number is within an acceptable range for seconds
[0-59]. Returns true if within range, otherwise false.
@@ -362,7 +372,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif Date.validateYear (
`Number` year ) : `Boolean`==
+==http://www.datejs.com/images/function.gif Date.validateYear==
+ ===Date.validateYear ( `Number` year ) : `Boolean`===
Validates the number is within an acceptable range for years [0-9999].
@@ -380,11 +391,12 @@
}}}
.
-= Public Instance Methods =
+=Public Instance Methods=
----
-==http://www.datejs.com/images/function.gif add ( `Object` config ) : `Date`==
+==http://www.datejs.com/images/function.gif add==
+ ===.add ( `Object` config ) : `Date`===
Adds (or subtracts) to the value of the year, month, day, hour,
minute, second, millisecond of the date instance using given
configuration object. Positive and Negative values allowed.
@@ -426,7 +438,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif addMilliseconds ( `Number`
milliseconds ) : `Date`==
+==http://www.datejs.com/images/function.gif addMilliseconds==
+ ===.addMilliseconds ( `Number` milliseconds ) : `Date`===
Adds the specified number of milliseconds to this instance.
@@ -445,7 +458,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif addSeconds ( `Number`
seconds ) : `Date`==
+==http://www.datejs.com/images/function.gif addSeconds==
+ ===.addSeconds ( `Number` seconds ) : `Date`===
Adds the specified number of seconds to this instance given the
number of seconds to add. The number can be positive or negative.
@@ -464,7 +478,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif addMinutes ( `Number`
minutes ) : `Date`==
+==http://www.datejs.com/images/function.gif addMinutes==
+ ===.addMinutes ( `Number` minutes ) : `Date`===
Adds the specified number of minutes to this instance given the
number of minutes to add. The number can be positive or negative.
@@ -483,7 +498,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif addHours ( `Number` hours
) : `Date`==
+==http://www.datejs.com/images/function.gif addHours==
+ ===.addHours ( `Number` hours ) : `Date`===
Adds the specified number of hours to this instance given the number
of hours to add. The number can be positive or negative.
@@ -522,7 +538,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif addWeeks ( `Number` weeks
) : `Date`==
+==http://www.datejs.com/images/function.gif addWeeks==
+ ===.addWeeks ( `Number` weeks ) : `Date`===
Adds the specified number of weeks to this instance given the number
of weeks to add. The number can be positive or negative.
@@ -541,7 +558,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif addMonths ( `Number`
months ) : `Date`==
+==http://www.datejs.com/images/function.gif addMonths==
+ ===.addMonths ( `Number` months ) : `Date`===
Adds the specified number of months to this instance given the number
of months to add. The number can be positive or negative.
@@ -560,7 +578,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif addYears ( `Number` years
) : `Date`==
+==http://www.datejs.com/images/function.gif addYears==
+ ===.addYears ( `Number` years ) : `Date`===
Adds the specified number of years to this instance given the number
of years to add. The number can be positive or negative.
@@ -579,7 +598,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif between ( `Date`
startDate, `Date` endDate ) : `Boolean`==
+==http://www.datejs.com/images/function.gif between==
+ ===.between ( `Date` startDate, `Date` endDate ) : `Boolean`===
Determines if this instance is between a range of two dates or equal
to either the start or end dates.
@@ -600,7 +620,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif isAfter ( `Date` date ) : `Boolean`==
+==http://www.datejs.com/images/function.gif isAfter==
+ ===.isAfter ( `Date` date ) : `Boolean`===
Determines if this date occurs after the date to compare to.
@@ -628,7 +649,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif isBefore ( `Date` date ) : `Boolean`==
+==http://www.datejs.com/images/function.gif isBefore==
+ ===.isBefore ( `Date` date ) : `Boolean`===
Determines if this date occurs before the date to compare to.
@@ -656,7 +678,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif clearTime ( ) : `Date`==
+==http://www.datejs.com/images/function.gif clearTime==
+ ===.clearTime ( ) : `Date`===
Resets the time of this Date object to 12:00 AM (00:00), which is the
start of the day.
@@ -674,7 +697,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif setTimeToNow ( ) : `Date`==
+==http://www.datejs.com/images/function.gif setTimeToNow==
+ ===.setTimeToNow ( ) : `Date`===
Resets the time of this Date object to the current time ('now').
@@ -692,7 +716,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif clone ( ) : `Date`==
+==http://www.datejs.com/images/function.gif clone==
+ ===.clone ( ) : `Date`===
Returns a new Date object that is an exact date and time copy of the
original instance.
@@ -724,7 +749,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif compareTo ( `Date` date
) : `Number`==
+==http://www.datejs.com/images/function.gif compareTo==
+ ===.compareTo ( `Date` date ) : `Number`===
Compares this instance to a Date object and returns an number
indication of their relative values. -1 = this is lessthan date. 0 =
values are equal. 1 = this is greaterthan date.
@@ -747,7 +773,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif equals ( `Date` date ) : `Boolean`==
+==http://www.datejs.com/images/function.gif equals==
+ ===.equals ( `Date` date ) : `Boolean`===
Compares this instance to another Date object and returns true if
they are equal, otherwise false.
@@ -769,7 +796,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif getOrdinalNumber ( ) : `Number`==
+==http://www.datejs.com/images/function.gif getOrdinalNumber==
+ ===.getOrdinalNumber ( ) : `Number`===
Get the Ordinal day (numeric day number) of the year, adjusted for
leap year. Returns 1 through 365 (366 in leap years).
@@ -788,7 +816,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif getTimezone ( ) : `String`==
+==http://www.datejs.com/images/function.gif getTimezone==
+ ===.getTimezone ( ) : `String`===
Get the timezone abbreviation of the current date.
@@ -806,7 +835,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif getUTCOffset ( ) : UTCOffset==
+==http://www.datejs.com/images/function.gif getUTCOffset==
+ ===.getUTCOffset ( ) : UTCOffset===
Get the offset from UTC of the current date. Returns the 4-character
offset string prefixed with + or - (e.g. "-0500").
@@ -824,7 +854,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif getWeek ( ) : `Number`==
+==http://www.datejs.com/images/function.gif getWeek==
+ ===.getWeek ( ) : `Number`===
Get the week number. Week one (1) is the week which contains the
first Thursday of the year. Monday is considered the first day of the week.
@@ -844,7 +875,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif getISOWeek ( ) : `String`==
+==http://www.datejs.com/images/function.gif getISOWeek==
+ ===.getISOWeek ( ) : `String`===
Get the ISO 8601 week number. Week one ("01") is the week which
contains the first Thursday of the year. Monday is considered the first
day of the week.
@@ -864,7 +896,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif *getElapsed* ( `Date` date
) : `Number`==
+==http://www.datejs.com/images/function.gif getElapsed==
+ ===.getElapsed ( `Date` date ) : `Number`===
Returns the number of milliseconds between this date and date.
@@ -882,7 +915,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif setWeek ( `Number` week
) : `Date`==
+==http://www.datejs.com/images/function.gif setWeek==
+ ===.setWeek ( `Number` week ) : `Date`===
Moves the date to Monday of the week set. Week one (1) is the week
which contains the first Thursday of the year.
@@ -900,7 +934,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif getOrdinalNumber ( ) : `Number`==
+==http://www.datejs.com/images/function.gif getOrdinalNumber==
+ ===.getOrdinalNumber ( ) : `Number`===
Get the Ordinal day (numeric day number) of the year, adjusted for
leap year. Return a number 1 through 365 (366 in leap years).
@@ -918,7 +953,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif hasDaylightSavingTime (
) : `Boolean`==
+==http://www.datejs.com/images/function.gif hasDaylightSavingTime==
+ ===.hasDaylightSavingTime ( ) : `Boolean`===
Indicates whether Daylight Saving Time is observed in the current
time zone.
@@ -936,7 +972,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif isDaylightSavingTime ( ) : `Boolean`==
+==http://www.datejs.com/images/function.gif isDaylightSavingTime==
+ ===.isDaylightSavingTime ( ) : `Boolean`===
Indicates whether this Date instance is within the Daylight Saving
Time range for the current time zone.
@@ -954,7 +991,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif moveToDayOfWeek ( `Number`
dayOfWeek, `Number` direction ) : `Date`==
+==http://www.datejs.com/images/function.gif moveToDayOfWeek==
+ ===.moveToDayOfWeek ( `Number` dayOfWeek, `Number` direction ) : `Date`===
Move to the next or previous dayOfWeek. Whether to move into the
future (+1) or past (-1) is controlled by the optional direction parameter.
@@ -974,7 +1012,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif moveToFirstDayOfMonth (
) : `Date`==
+==http://www.datejs.com/images/function.gif moveToFirstDayOfMonth==
+ ===.moveToFirstDayOfMonth ( ) : `Date`===
Moves the date to the first day of the month.
@@ -992,7 +1031,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif moveToLastDayOfMonth (
) : `Date`==
+==http://www.datejs.com/images/function.gif moveToLastDayOfMonth==
+ ===.moveToLastDayOfMonth ( ) : `Date`===
Moves the date to the last day of the month.
@@ -1010,7 +1050,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif moveToMonth ( `Number`
month, `Number` direction ) : `Date`==
+==http://www.datejs.com/images/function.gif moveToMonth==
+ ===.moveToMonth ( `Number` month, `Number` direction ) : `Date`===
Move to the next or previous month. Whether to move into the future
(+1) or past (-1) is controlled by the optional direction parameter.
@@ -1030,7 +1071,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif moveToNthOccurrence (
`Number` dayOfWeek, `Number` occurrence ) : `Date`==
+==http://www.datejs.com/images/function.gif moveToNthOccurrence==
+ ===.moveToNthOccurrence ( `Number` dayOfWeek, `Number` occurrence ) : `Date`===
Moves the date to the next n'th occurrence of the dayOfWeek starting
from the beginning of the month. The number (-1) is a magic number and
will return the last occurrence of the dayOfWeek in the month.
@@ -1051,7 +1093,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif set ( `Object` config ) : `Date`==
+==http://www.datejs.com/images/function.gif set==
+ ===.set ( `Object` config ) : `Date`===
Set the value of year, month, day, hour, minute, second, millisecond
of date instance using given configuration object.
@@ -1092,7 +1135,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif setTimezone ( `String`
timezoneAbbreviation ) : `Date`==
+==http://www.datejs.com/images/function.gif setTimezone==
+ ===.setTimezone ( `String` timezoneAbbreviation ) : `Date`===
Set the timezone for the current date using a [CultureInfo
culture-specific] timezone abbreviation ("PST"). Note that in
most !JavaScript implementations, this will appear to change the time
since the timezone is always based on the locale.
@@ -1109,7 +1153,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif setTimezoneOffset (
`Number` timezoneOffset ) : `Date`==
+==http://www.datejs.com/images/function.gif setTimezoneOffset==
+ ===.setTimezoneOffset ( `Number` timezoneOffset ) : `Date`===
Set the timezone for the current date using an offset (-0700). Note
that in most !JavaScript implementations, this will appear to change
the time since the timezone is always based on the locale.
@@ -1127,7 +1172,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif toISOString ( ) : `String`==
+==http://www.datejs.com/images/function.gif toISOString==
+ ===.toISOString ( ) : `String`===
Converts the current date instance into a string with an ISO 8601
format. The date is converted to it's UTC value. As per the ISO 8601
specification, the string will be wrapped with double quotation marks (").
@@ -1152,7 +1198,8 @@
}}}
.
-==http://www.datejs.com/images/function.gif toString ( `String` format
) : `String`==
+==http://www.datejs.com/images/function.gif toString==
+ ===.toString ( `String` format ) : `String`===
Converts the value of the current Date object to its equivalent
string representation. Use format argument to specify format
(optional). See FormatSpecifiers for more info.