Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
d8 is a date parsing and formatting micro-framework for modern JavaScript engines.
JavaScript
Tree: d80eb16904

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
locale
src
test
.catn8
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
d8.js
d8.min.js
package.json

README.md

d8.js build status

d8 is a date parsing and formatting micro-framework for modern JavaScript engines.

d8 formats Dates into Strings and conversley turns Strings into Dates based on php formatting options.

As d8 extends JavaScript's native Date & Date.prototype – the CORRECT way – there is no actual global called d8. Instead all static and instance methods are available on the native Date & Date.prototype respectively.

currently the only locales available are:

  • en-GB (0.9kb gzipped)
  • en-US (0.9kb gzipped)

but feel free to create a locale for your specific nationality and submit a pull request! :D

Dependencies

d8.js only has one dependency m8.js.

NOTE: If you are using d8 within a commonjs module, you don't need to require m8 before requiring d8 as this is done internally.

Also, since d8.js simply extends the Native Date Class, a reference to m8 IS NOT stored.

browser usage

   <script src="/path/to/m8/m8.js" type="text/javascript"></script>

<!-- IMPORTANT: The correct locale must be loaded before d8! -->
   <script src="/path/to/d8/locale/en-GB.js" type="text/javascript"></script>
   <script src="/path/to/d8/d8.min.js" type="text/javascript"></script>

nodejs usage

    require( 'd8/locale/en-GB' ); // IMPORTANT: The correct locale must be loaded before d8!!
    require( 'd8' );

 // if running in a sandboxed environment remember to:
    require( 'm8' ).x( Date ); // and/ or any other Types that require extending.

As mentioned above d8 extends JavaScript's native Date & Date.prototype, so when requiring d8, you don't need to assign it to a variable to use d8's features.

Support

Tested to work with nodejs, FF4+, Safari 5+, Chrome 7+, IE9+. Should technically work in any browser that supports ecma 5 without throwing any JavaScript errors.

API

Static methods

isLeapYear( year:String ):Boolean

Returns true if the passed 4 digit year is a leap year.

NOTE: This method is located in the locale file. If your calendar system does not contain leap years, you can simply change the method to only return false.

getOrdinal( date:Number ):String

Returns the ordinal for a given date.

Example:
     Date.getOrdinal( 1 );  // returns => "st"
     Date.getOrdinal( 10 ); // returns => "th"
     Date.getOrdinal( 22 ); // returns => "nd"
     Date.getOrdinal( 33 ); // returns => "rd"

NOTE: Ordinals and the getOrdinal This method is located in the locale file. You can simply change the ordinal Array to your specific language; overwrite the getOrdinal method or both.

setLeapYear( date:Date ):Void

Sets the inlcuded locale's February day count to the correct number of days, based on whether or not the date is a leap year or not.

NOTE: This method is located in the locale file. If your calendar system does not contain leap years, you can simply change the method to do nothing.

toDate( date:String, format:String ):Date

Takes a date String and a format String based on the Date formatting and parsing options described below and returns a – hopefully – correct and valid Date.

    Date.toDate( 'Sunday, the 1st of January 2012', 'l, <the> jS <of> F Y' ); // returns => Date { Sun Jan 01 2012 00:00:00 GMT+0000 (GMT) }
    Date.toDate( '2012-01-01T00:00:00+00:00',        Date.formats.ISO_8601 ); // returns => Date { Sun Jan 01 2012 00:00:00 GMT+0000 (GMT) }

Static properties

filters

An Object of all the available filters for formatting a Date.

IMPORTANT: Don't change these unless you know what you are doing!

formats

An Object containing some default date formats:

ISO_8601Y-m-dH:i:sP
ISO_8601_SHORTY-m-d
RFC_850l, d-M-y H:i:s T
RFC_2822D, d M Y H:i:s O
sortableY-m-d H:i:sO

Instance methods

adjust( interval:Object|String[, value:Number] ):Date

Your one stop shop for all Date arithmetic. Adjusts the Date based on the passed interval, by the passed numeric value.

Note: The method also accepts a single Object param where each key is the interval and each value is the number to adjust the Date by.

Valid intervals are: year, month, week, day, hr, min, sec, ms.

Example:
    var date = new Date( 2012, 0, 1 ); // Date {Sun Jan 01 2012 00:00:00 GMT+0000 (GMT)}

    date.adjust( Date.DAY,   1 );      // Date {Mon Jan 02 2012 00:00:00 GMT+0000 (GMT)}
    date.adjust( Date.HOUR, -1 );      // Date {Sun Jan 01 2012 23:00:00 GMT+0000 (GMT)}
    date.adjust( {
       year : -1, month : -1, day : 24,
       hr   :  1, sec   : -1
    } );                               // Date {Sat Dec 25 2010 23:59:59 GMT+0000 (GMT)}

between( date_lower:Date, date_higher:Date ):Boolean

Checks to see if the Date instance is in between the two passed Dates.

Example:
    var date = new Date( 2012, 0, 1 );

    date.between( new Date( 2011, 0, 1 ), new Date( 2013, 0, 1 ) ); // returns => true;

    date.between( new Date( 2013, 0, 1 ), new Date( 2011, 0, 1 ) ); // returns => false;

clearTime():Date

Clears the time from the Date instance.

clone():Date

Returns a clone of the current Date.

diff( [date:Date, exclude:String] ):Object

Returns an Object describing the difference between the Date instance and now — or the optionally passed Date.

The Object will contain any or all of the following properties:

PropTypeDescription
tenseNumberThis will either be:
-1
The Date instance is less than now or the passed Date, i.e. in the past
0
The Date instance is euqal to now or the passed Date, i.e. in the present.
NOTE: If tense is 0 then the Object will most probably have no other properties.
1
The Date instance is greater than now or the passed Date, i.e. in the future
NOTE: All other properties Numbers will be positive Numbers as you will know if the diff is in the past, present or future by using this property.
valueNumberThe — absolute — number of milliseconds difference between the two Dates.
yearsNumberThe number of years the Date instance is ahead or behind the passed Date.
monthsNumberThe months of years the Date instance is ahead or behind the passed Date.
weeksNumberThe weeks of years the Date instance is ahead or behind the passed Date.
daysNumberThe days of years the Date instance is ahead or behind the passed Date.
hoursNumberThe hours of years the Date instance is ahead or behind the passed Date.
minutesNumberThe minutes of years the Date instance is ahead or behind the passed Date.
secondsNumberThe seconds of years the Date instance is ahead or behind the passed Date.
millisecondsNumberThe milliseconds of years the Date instance is ahead or behind the passed Date.

NOTE: If any of the properties — other than tense — is zero it will be removed from the diff Object.

NOTE: You can supply a space delimited a String defining which properties you want to exclude from the result and diff will try and round off to the nearest time frame.

Example:
     ( new Date( 2012, 0, 1 ) ).diff( new Date( 2012, 0, 1 ) )             // returns => { tense :  0 }

     ( new Date( 2012, 0, 1 ) ).diff( new Date( 2012, 0, 2 ) )             // returns => { tense : -1, days : 1 }

     ( new Date( 2012, 0, 2 ) ).diff( new Date( 2012, 0, 1 ) )             // returns => { tense :  1, days : 1 }

     ( new Date( 2012, 0, 1 ) ).diff( new Date( 2010, 9, 8, 7, 6, 5, 4 ) ) // returns => { tense :  1, years : 1, months : 9, weeks : 2, days : 1, hours : 17, minutes : 6, seconds : 54, ms : 4 }

format( format:String ):String

Returns a string representation of the Date instance, based on the passed format. See the Date formatting and parsing options below.

Example:
    ( new Date( 2012, 0, 1 ) ).format( 'c' );                   // returns => "2012-01-01T00:00:00.000Z"
 // which is a short hand format for:
    ( new Date( 2012, 0, 1 ) ).format( 'Y-m-d<T>H:i:s.u<Z>' );  // returns => "2012-01-01T00:00:00.000Z"

    ( new Date( 2012, 0, 1 ) ).format( 'l, <the> nS <of> F Y' ) // returns => "Sunday, the 1st of January 2012"

You can use predefined formats found in Date.formats. Hint: You can do:

    console.dir( Date.formats );

within your browser's JavaScript console to see a list of available formats.

Previously used formats are also cached to save the overhead of having to create a new Function everytime you want to format a date.

getDayOfYear():Number

Returns the zero based day of the year.

getFirstOfTheMonth():Date

Returns a Date instance of the first day of this Date instance's month.

getGMTOffset( [colon:Boolean] ):String

Returns the Date instances offset from GMT.

getISODay():Number

Returns the ISO day of the week.

getISODaysInYear():Number

Returns the ISO number of days in the year.

getISOFirstMondayOfYear():Date

Returns the ISO first Monday of the year.

getISOWeek():Number

Returns the ISO week of the year

getISOWeeksInYear():Number

Returns the number of weeks in the ISO year.

getLastOfTheMonth():Date

Returns a Date instance of the last day of this Date instance's month.

getWeek():Number

Returns the week of the year, based on the dayOfYear divided by 7.

Example:
    ( new Date( 2012, 0, 1 ) ).getWeek();   // returns => 0
    ( new Date( 2012, 2, 13 ) ).getWeek();  // returns => 10
    ( new Date( 2012, 11, 31 ) ).getWeek(); // returns => 52

isDST():Boolean

Returns true if the Date instance is within daylight savings time.

isLeapYear():Boolean

Returns true if the Date instance is a leap year.

setWeek():Number(UnixTimeStamp)

Sets the week of the year from the 1st January.

Example:
    new Date( ( new Date( 2012, 0, 1 ) ).setWeek( 17 ) ); // returns => Date {Sun Apr 29 2012 00:00:00 GMT+0100 (BST)}

    ( new Date( 2012, 2, 13 ) ).setWeek( 17 );            // returns => 1335654000000 same as above

    ( new Date( 2012, 11, 31 ) ).setWeek( 17 );           // returns => 1335654000000

timezone():String

Returns the JavaScript engine's Date.prototype.toString() timezone abbreviation.

Date formatting and parsing options

escaping characters

If you want to escape characters that are used by the Date parser you can wrap them between <>.

Example:

    ( new Date( 2012, 0, 1 ) ).format( 'l, <the> jS <of> F Y' ); // returns => "Sunday, the 1st of January 2012"

day

dDay of the month, 2 digits with leading zeros
DA textual representation of a day, three letters
jDay of the month without leading zeros
lA full textual representation of the day of the week
NISO-8601 numeric representation of the day of the week
SEnglish ordinal suffix for the day of the month, 2 characters
wNumeric representation of the day of the week
zThe day of the year (starting from 0)

week

WISO-8601 week number of year, weeks starting on Monday

month

FA full textual representation of a month
mNumeric representation of a month, with leading zeros
MA short textual representation of a month, three letters
nNumeric representation of a month, without leading zeros
tNumber of days in the given month

year

LWhether it's a leap year
oISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead.
YA full numeric representation of a year, 4 digits
yA two digit representation of a year

time

aLowercase Ante meridiem and Post meridiem
AUppercase Ante meridiem and Post meridiem
g12-hour format of an hour without leading zeros
G24-hour format of an hour without leading zeros
h12-hour format of an hour with leading zeros
H24-hour format of an hour with leading zeros
iMinutes with leading zeros
sSeconds, with leading zeros
uMilliseconds

timezone

ODifference to Greenwich time (GMT) in hours
PDifference to Greenwich time (GMT) with colon between hours and minutes
TTimezone abbreviation
ZTimezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive.

full date/time

cISO 8601 date
rRFC 2822 formatted date
USeconds since the Unix Epoch January 1 1970 00:00:00 GMT

File size

  • d8.js ≅ 6.8kb (gzipped)
  • d8.min.js ≅ 3.9kb (minzipped)

License

(The MIT License)

Copyright © 2012 christos "constantology" constandinou http://muigui.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.