Built-In Class Date

Defined In:	Date.js.
Class:	Date

The date parsing and format syntax is a subset of
PHP's date() function, and the formats that are
supported will provide results equivalent to their PHP versions.

Following is the list of all currently supported formats:


Sample date:
'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)'

Format  Output      Description
------  ----------  --------------------------------------------------------------
  d      10         Day of the month, 2 digits with leading zeros
  D      Wed        A textual representation of a day, three letters
  j      10         Day of the month without leading zeros
  l      Wednesday  A full textual representation of the day of the week
  S      th         English ordinal day of month suffix, 2 chars (use with j)
  w      3          Numeric representation of the day of the week
  z      9          The julian date, or day of the year (0-365)
  W      01         ISO-8601 2-digit week number of year, weeks starting on Monday (00-52)
  F      January    A full textual representation of the month
  m      01         Numeric representation of a month, with leading zeros
  M      Jan        Month name abbreviation, three letters
  n      1          Numeric representation of a month, without leading zeros
  t      31         Number of days in the given month
  L      0          Whether it's a leap year (1 if it is a leap year, else 0)
  Y      2007       A full numeric representation of a year, 4 digits
  y      07         A two digit representation of a year
  a      pm         Lowercase Ante meridiem and Post meridiem
  A      PM         Uppercase Ante meridiem and Post meridiem
  g      3          12-hour format of an hour without leading zeros
  G      15         24-hour format of an hour without leading zeros
  h      03         12-hour format of an hour with leading zeros
  H      15         24-hour format of an hour with leading zeros
  i      05         Minutes with leading zeros
  s      01         Seconds, with leading zeros
  O      -0600      Difference to Greenwich time (GMT) in hours (Allows +08, without minutes)
  P      -06:00     Difference to Greenwich time (GMT) with colon between hours and minutes
  T      CST        Timezone setting of the machine running the code
  Z      -21600     Timezone offset in seconds (negative if west of UTC, positive if east)

Example usage (note that you must escape format specifiers with '\\' to render them as character literals):


var dt = new Date('1/10/2007 03:05:01 PM GMT-0600');
document.write(dt.format('Y-m-d'));                         //2007-01-10
document.write(dt.format('F j, Y, g:i a'));                 //January 10, 2007, 3:05 pm
document.write(dt.format('l, \\t\\he dS of F Y h:i:s A'));  //Wednesday, the 10th of January 2007 03:05:01 PM

Here are some standard date/time patterns that you might find helpful. They
are not part of the source of Date.js, but to use them you can simply copy this
block of code into any script that is included after Date.js and they will also become
globally available on the Date object. Feel free to add or remove patterns as needed in your code.


Date.patterns = {
    ISO8601Long:"Y-m-d H:i:s",
    ISO8601Short:"Y-m-d",
    ShortDate: "n/j/Y",
    LongDate: "l, F d, Y",
    FullDateTime: "l, F d, Y g:i:s A",
    MonthDay: "F d",
    ShortTime: "g:i A",
    LongTime: "g:i:s A",
    SortableDateTime: "Y-m-d\\TH:i:s",
    UniversalSortableDateTime: "Y-m-d H:i:sO",
    YearMonth: "F, Y"
};

Example usage:


var dt = new Date();
document.write(dt.format(Date.patterns.ShortDate));

Class Comments / Notes => [Add Your comment/notes about this class]

Public Properties
	Description	Defined By
Date.DAY : String	Date interval constant Date interval constant	Date
Date.HOUR : String	Date interval constant Date interval constant	Date
Date.MILLI : String	Date interval constant Date interval constant	Date
Date.MINUTE : String	Date interval constant Date interval constant	Date
Date.MONTH : String	Date interval constant Date interval constant	Date
Date.SECOND : String	Date interval constant Date interval constant	Date
Date.YEAR : String	Date interval constant Date interval constant	Date
Date.dayNames : Array	An array of textual day names. An array of textual day names. Override these values for international dates, for example... Date.dayNames = ['SundayInYourLang', 'MondayInYourLang', ...];	Date
Date.monthNames : Array	An array of textual month names. An array of textual month names. Override these values for international dates, for example... Date.monthNames = ['JanInYourLang', 'FebInYourLang', ...];	Date

Public Methods
Method		Defined By
	Date.parseDate (String *input, String format) : Date Parses the passed string using the specified format. Parses the passed string using the specified format. Note that this function expects dates in normal calendar format, meaning that months are 1-based (1 = January) and not zero-based like in JavaScript dates. Any part of the date format that is not specified will default to the current date value for that part. Time parts can also be specified, but default to 0. Keep in mind that the input date string must precisely match the specified format string or the parse operation will fail. Example Usage: `//dt = Fri May 25 2007 (current date) var dt = new Date(); //dt = Thu May 25 2006 (today's month/day in 2006) dt = Date.parseDate("2006", "Y"); //dt = Sun Jan 15 2006 (all date parts specified) dt = Date.parseDate("2006-1-15", "Y-m-d"); //dt = Sun Jan 15 2006 15:20:01 GMT-0600 (CST) dt = Date.parseDate("2006-1-15 3:20:01 PM", "Y-m-d h:i:s A" );` Parameters: String input* The unparsed date as a string String format The format the date is in Returns: Date The parsed date	Date
	add (String *interval, Number value) : Date Provides a convenient method of performing basic date arithmetic. Provides a convenient method of performing basic date arithmetic. This method does not modify the Date instance being called - it creates and returns a new Date instance containing the resulting date value. Examples: `//Basic usage: var dt = new Date('10/29/2006').add(Date.DAY, 5); document.write(dt); //returns 'Fri Oct 06 2006 00:00:00' //Negative values will subtract correctly: var dt2 = new Date('10/1/2006').add(Date.DAY, -5); document.write(dt2); //returns 'Tue Sep 26 2006 00:00:00' //You can even chain several calls together in one line! var dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30); document.write(dt3); //returns 'Fri Oct 06 2006 07:30:00'` Parameters: String interval* A valid date interval enum value Number value The amount to add to the current date Returns: Date The new Date instance	Date
	clearTime (Boolean *clone) : Date Clears any time information from this date Clears any time information from this date Parameters: Boolean clone* true to create a clone of this date, clear the time and return it Returns: Date this or the clone	Date
	clone () : Date Creates and returns a new Date instance with the exact same date value as the called instance. Creates and returns a new Date instance with the exact same date value as the called instance. Dates are copied and passed by reference, so if a copied date variable is modified later, the original variable will also be changed. When the intention is to create a new variable that will not modify the original instance, you should create a clone. Example of correctly cloning a date: `//wrong way: var orig = new Date('10/1/2006'); var copy = orig; copy.setDate(5); document.write(orig); //returns 'Thu Oct 05 2006'! //correct way: var orig = new Date('10/1/2006'); var copy = orig.clone(); copy.setDate(5); document.write(orig); //returns 'Thu Oct 01 2006'` Returns: Date The new Date instance	Date
	format (String *format) : String Formats a date given the supplied format string Formats a date given the supplied format string Parameters: String format* The format string Returns: String The formatted date	Date
	getDayOfYear () : Number Get the numeric day number of the year, adjusted for leap year. Get the numeric day number of the year, adjusted for leap year. Returns: Number 0 through 364 (365 in leap years)	Date
	getDaysInMonth () : Number Get the number of days in the current month, adjusted for leap year. Get the number of days in the current month, adjusted for leap year. Returns: Number The number of days in the month	Date
	getElapsed (Date *date) : Number Returns the number of milliseconds between this date and date Returns the number of milliseconds between this date and date Parameters: Date date* (optional) Defaults to now Returns: Number The diff in milliseconds	Date
	getFirstDateOfMonth () : Date Get the first date of this date's month Get the first date of this date's month Returns: Date	Date
	getFirstDayOfMonth () : Number Get the first day of the current month, adjusted for leap year. Get the first day of the current month, adjusted for leap year. The returned value is the numeric day index within the week (0-6) which can be used in conjunction with the {link monthNames} array to retrieve the textual day name. Example: `var dt = new Date('1/10/2007'); document.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday'` Returns: Number The day number (0-6)	Date
	getGMTColonOffset () : String Get the offset from GMT of the current date (equivalent to the format specifier 'P'). Get the offset from GMT of the current date (equivalent to the format specifier 'P'). Returns: String 2-characters representing hours and 2-characters representing minutes seperated by a colon and prefixed with + or - (e.g. '-06:00')	Date
	getGMTOffset () : String Get the offset from GMT of the current date (equivalent to the format specifier 'O'). Get the offset from GMT of the current date (equivalent to the format specifier 'O'). Returns: String The 4-character offset string prefixed with + or - (e.g. '-0600')	Date
	getLastDateOfMonth () : Date Get the last date of this date's month Get the last date of this date's month Returns: Date	Date
	getLastDayOfMonth () : Number Get the last day of the current month, adjusted for leap year. Get the last day of the current month, adjusted for leap year. The returned value is the numeric day index within the week (0-6) which can be used in conjunction with the {link monthNames} array to retrieve the textual day name. Example: `var dt = new Date('1/10/2007'); document.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday'` Returns: Number The day number (0-6)	Date
	getSuffix () : String Get the English ordinal suffix of the current day (equivalent to the format specifier 'S'). Get the English ordinal suffix of the current day (equivalent to the format specifier 'S'). Returns: String 'st, 'nd', 'rd' or 'th'	Date
	getTimezone () : String Get the timezone abbreviation of the current date (equivalent to the format specifier 'T'). Get the timezone abbreviation of the current date (equivalent to the format specifier 'T'). Returns: String The abbreviated timezone name (e.g. 'CST')	Date
	getWeekOfYear () : String Get the string representation of the numeric week number of the year (equivalent to the format specifier 'W'). Get the string representation of the numeric week number of the year (equivalent to the format specifier 'W'). Returns: String '00' through '52'	Date
	isLeapYear () : Boolean Whether or not the current date is in a leap year. Whether or not the current date is in a leap year. Returns: Boolean True if the current date is in a leap year, else false	Date

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT) Based on JsDoc Toolkit