simpletime
v0.3.1
Published
Convert and manipulate various time formats..
Downloads
77
Maintainers
Readme
simpletime
(c)Bumblehead
simpletime manages dates and renders them to unicode formats. (i18n through worldtime).
- formats and extracts dates with unicode forms
- uses
YMDArr
objects to simplify time manipulation - does not depend on a library
simpletime.extractDateFormatted(
'April 5, 2013 9:23:41 pm 420',
'MMMM d, y h:mm:ss a z'
);
// Fri Apr 05 2013 21:23:41 GMT-0700 (PDT)
simpletime.applyFormatDate(
new Date('Fri Apr 05 2013 21:23:41 GMT-0700 (PDT)'),
'MMMM d, y h:mm:ss a z'
);
// 'April 5, 2013 9:23:41 pm 420'
simpletime.getElapsedTimeObj(
new Date('Sun Apr 07 2013 18:08:45 GMT-0700 (PDT)'),
new Date('Sun Apr 07 2013 23:59:59 GMT-0700 (PDT)')
);
// { ms: 0, sec: 14, min: 51, hour: 5, day: 0 }
functions
isDateObj ( dateObj )
returns a
boolean
, is the given dateObj a valid Date object?ex,
simpletime.isDateObj(new Date()); // true
getDateYNum ( dateObj )
returns a
number
, the year on the date object.ex,
simpletime.getDateYNum(new Date()); // 2016
getDateYStr ( dateObj )
returns a
string
, the year on the date object.ex,
simpletime.getDateYStr(new Date()); // '2016'
getDateMNum ( dateObj )
returns a
number
, the month on the date object.ex,
simpletime.getDateMNum(new Date()); // 12
getDateMStr ( dateObj )
returns a
string
, the month on the date object.ex,
simpletime.getDateMStr(new Date()); // '12'
getDateDNum ( dateObj )
returns a
number
, the day on the date object.ex,
simpletime.getDateDNum(new Date()); // 31
getDateDStr ( dateObj )
returns a
string
, the day on the date object.ex,
simpletime.getDateDStr(new Date()); // '31'
getDateYMDNumArr ( dateObj )
return an array of numbers, the YNum, MNum and DNum of a date object.
ex,
simpletime.getDateYMDNumArr(new Date()); // [2016, 12, 31]
getDateYMDStrArr ( dateObj )
return an array of strings, the YStr, MStr and DStr of a date object.
ex,
simpletime.getDateYMDStrArr(new Date()); // ['2016', '12', '31']
getYMDArrDate ( ymdArr )
return a Date object from a YMDNumArr or YMDStrArr
ex,
simpletime.getYMDArrDate([2016, 12, 31]); // Sat Dec 31 2016 17:43:20 GMT-0800 (PST)
getMinFromDate ( dateObj, optNum )
return a Date object with given number of minutes added.
ex,
var date = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); simpletime.getMinFromDate(date, 5); // Sat Dec 31 2016 17:48:20 GM... simpletime.getMinFromDate(date, 50); // Sat Dec 31 2016 18:33:20 GM... simpletime.getMinFromDate(date, -5); // Sat Dec 31 2016 17:38:20 GM... simpletime.getMinFromDate(date, -50); // Sat Dec 31 2016 16:53:20 GM...
getMinFromTodayDate ( optNum )
returns a Date object with given number of minutes added to now's new Date()
ex
simpletime.getMinFromTodayDate(5); // Sat Dec 31 2016 17:48:20 GMT... simpletime.getMinFromTodayDate(50); // Sat Dec 31 2016 18:33:20 GMT... simpletime.getMinFromTodayDate(-5); // Sat Dec 31 2016 17:38:20 GMT... simpletime.getMinFromTodayDate(-50); // Sat Dec 31 2016 16:53:20 GMT...
getDayFromDate ( dateObj, optNum )
returns a Date object with given number of days added
ex,
var date = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); simpletime.getDayFromDate(date, 5); // Thu Jan 05 2017 17:55:40 GM... simpletime.getDayFromDate(date, 50); // Sun Feb 19 2017 17:55:40 GM... simpletime.getDayFromDate(date, -5); // Mon Dec 26 2016 17:55:40 GM... simpletime.getDayFromDate(date, -50); // Fri Nov 11 2016 17:55:40 GM...
getDayFromTodayDate ( optNum )
returns a Date object with given number of days added to now's new Date()
ex,
simpletime.getDayFromTodayDate(5); // Thu Jan 05 2017 17:55:40 GMT... simpletime.getDayFromTodayDate(50); // Sun Feb 19 2017 17:55:40 GMT... simpletime.getDayFromTodayDate(-5); // Mon Dec 26 2016 17:55:40 GMT... simpletime.getDayFromTodayDate(-50); // Fri Nov 11 2016 17:55:40 GMT...
getMonthFromDate ( dateObj, optNum )
returns a Date object with given number of months added
ex,
var date = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); simpletime.getMonthFromDate(date, 5); // Wed May 31 2017 17:58:55 ... simpletime.getMonthFromDate(date, 50); // Sun Feb 28 2021 17:58:55 ... simpletime.getMonthFromDate(date, -5); // Sun Jul 31 2016 17:58:55 ... simpletime.getMonthFromDate(date, -50); // Wed Oct 31 2012 17:58:55 ...
getMonthFromTodayDate ( optNum )
returns a Date object with given number of months added to now's Date.now()
ex,
simpletime.getMonthFromTodayDate(5); // Wed May 31 2017 17:58:55 G... simpletime.getMonthFromTodayDate(50); // Sun Feb 28 2021 17:58:55 G... simpletime.getMonthFromTodayDate(-5); // Sun Jul 31 2016 17:58:55 G... simpletime.getMonthFromTodayDate(-50); // Wed Oct 31 2012 17:58:55 G...
getYearFromDate ( optNum )
returns a Date object with given number of years added
ex,
var date = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); simpletime.getYearFromDate(date, 5); // Fri Dec 31 2021 18:07:54 G... simpletime.getYearFromDate(date, 50); // Fri Dec 31 2066 18:07:54 G... simpletime.getYearFromDate(date, -5); // Sat Dec 31 2011 18:07:54 G... simpletime.getYearFromDate(date, -50); // Sat Dec 31 1966 18:07:54 G...
getYearFromTodayDate ( optNum )
returns a Date object with given number of years added to now's Date.now()
ex,
simpletime.getYearFromTodayDate(5); // Fri Dec 31 2021 18:07:54 GM... simpletime.getYearFromTodayDate(50); // Fri Dec 31 2066 18:07:54 GM... simpletime.getYearFromTodayDate(-5); // Sat Dec 31 2011 18:07:54 GM... simpletime.getYearFromTodayDate(-50); // Sat Dec 31 1966 18:07:54 GM...
getDaysInMonth ( yearNum, monthNum )
return the number of days found in the give month for the given year
ex,
simpletime.getDaysInMonth(2015, 2); // 28 simpletime.getDaysInMonth(2014, 2); // 28 simpletime.getDaysInMonth(2013, 2); // 28 simpletime.getDaysInMonth(2012, 2); // 29
getMFittedYMDNumArr ( YMDNumArr )
return a YMDNumArr with the month value 'fitted' to fall within the range of 1 and 12.
ex,
simpletime.getMFittedYMDNumArr([2015, 2, 2]); // [2015, 2, 2] simpletime.getMFittedYMDNumArr([2015, 0, 2]); // [2015, 1, 2] simpletime.getMFittedYMDNumArr([2015, 13, 2]); // [2015, 12, 2]
getDFittedYMDNumArr ( YMDNumArr )
return a YMDNumArr with the day value 'fitted' to fall within the range of days in the given month and year.
ex,
simpletime.getDFittedYMDNumArr([2015, 2, 2]); // [2015, 2, 2] simpletime.getDFittedYMDNumArr([2015, 2, -4]); // [2015, 2, 1] simpletime.getDFittedYMDNumArr([2015, 2, 35]); // [2015, 2, 28] simpletime.getDFittedYMDNumArr([2012, 2, 35]); // [2014, 2, 29]
getTimeBgnMonth ( dateObj )
return a date from given dateObj, set to day 1, hour 0, minute 0, second 0, millisecond 0
ex,
simpletime.getTimeBgnMonth( new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)') ); // Thu Dec 01 2016 00:00:00 GMT-0800 (PST)
getTimeEndMonth ( dateObj )
return a date from given dateObj, set to day last, hour 23, minute 59, second 59, millisecond 999
ex,
simpletime.getTimeEndMonth( new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)') ); // Sat Dec 31 2016 23:59:59 GMT-0800 (PST)
getTimeBgnDay ( dateObj )
return a date from given dateObj, set to hour 0, minute 0, second 0, millisecond 0
ex,
simpletime.getTimeBgnDay( new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)') ); // Sat Dec 31 2016 00:00:00 GMT-0800 (PST)
getTimeEndDay ( dateObj )
return a date from given dateObj, set to hour 23, minute 0, second 0, millisecond 0
ex,
simpletime.getTimeEndDay( new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)') ); // Sat Dec 31 2016 23:59:59 GMT-0800 (PST)
isDateBeforeDate ( dateObj, dateObj )
return a boolean value, is the date object before given date?
ex,
simpletime.isDateBeforeDate( new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'), new Date('Sat Dec 31 2016 6:43:20 GMT-0800 (PST)') ); // false
isDateBeforeToday ( dateObj )
return a boolean value, is the date object before date.now()?
ex,
Date.now(); // Sat Dec 31 2016 17:43:20 GMT-0800 (PST) simpletime.isDateBeforeToday( new Date('Sat Dec 31 2016 6:43:20 GMT-0800 (PST)') ); //false
parseISO8601 ( str )
return a date object from a simple ISO formatted string date, format yyyy.mm.dd, yyyy/mm/dd, or yyyy-mm-dd
ex,
simpletime.parseISO8601('2016/12/31'); // Sat Dec 31 2016 6:43:20 GMT-0800 (PST)
parseUSEndian ( str )
return a date object from a simple endian formatted string date, format mm.dd.yyyy, mm/dd/yyyy, or mm-dd-yyyy
ex,
simpletime.parseISO8601('12/31/2016'); // Sat Dec 31 2016 6:43:20 GMT-0800 (PST)
yieldRangeMonthly ( bgnDateObj, endDateObj, fn )
return a monthly array of dates within the range of bgnDate and endDate. An optional filter function may be provided as the third parameter.
ex,
var bgndate = new Date('Sat Dec 5 2015 17:43:20 GMT-0800 (PST)'), enddate = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); simpletime.yieldRangeMonthly(bgndate, enddate); // [ Sat Dec 05 2015 17:43:20 GMT-0800 (PST), // Tue Jan 05 2016 19:16:57 GMT-0800 (PST), // Fri Feb 05 2016 19:16:57 GMT-0800 (PST), // Sat Mar 05 2016 19:16:57 GMT-0800 (PST), // Tue Apr 05 2016 19:16:57 GMT-0700 (PDT), // Thu May 05 2016 19:16:57 GMT-0700 (PDT), // Sun Jun 05 2016 19:16:57 GMT-0700 (PDT), // Tue Jul 05 2016 19:16:57 GMT-0700 (PDT), // Fri Aug 05 2016 19:16:57 GMT-0700 (PDT), // Mon Sep 05 2016 19:16:57 GMT-0700 (PDT), // Wed Oct 05 2016 19:16:57 GMT-0700 (PDT), // Sat Nov 05 2016 19:16:57 GMT-0700 (PDT), // Mon Dec 05 2016 19:16:57 GMT-0800 (PST) ]
yieldRangeDaily ( bgnDateObj, endDateObj, fn )
return a daily array of dates within the range of bgnDate and endDate. An optional filter function may be provided as the third parameter.
ex,
var bgndate = new Date('Sat Dec 23 2016 17:43:20 GMT-0800 (PST)'), enddate = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); simpletime.yieldRangeDaily(bgndate, enddate); // [ Fri Dec 23 2016 17:43:20 GMT-0800 (PST), // Sat Dec 24 2016 19:19:20 GMT-0800 (PST), // Sun Dec 25 2016 19:19:20 GMT-0800 (PST), // Mon Dec 26 2016 19:19:20 GMT-0800 (PST), // Tue Dec 27 2016 19:19:20 GMT-0800 (PST), // Wed Dec 28 2016 19:19:20 GMT-0800 (PST), // Thu Dec 29 2016 19:19:20 GMT-0800 (PST), // Fri Dec 30 2016 19:19:20 GMT-0800 (PST) ]
applyFormatDate ( dateObj , formatStr )
return a date that is formatted according to the given unicode formatStr
ex,
simpletime.applyFormatDate( new Date('Fri Apr 05 2013 21:23:41 GMT-0700 (PDT)'), 'MMMM d, y h:mm:ss a z' ); // 'April 5, 2013 9:23:41 pm 420'
getDateAsISO ( dateObj )
return a simplified ISO formatted date from a date object (yyyy/mm/dd)
ex,
simpletime.getDateAsISO( new Date('Sat Dec 23 2016 17:43:20 GMT-0800 (PST)') ); // '2016/12/23'
getDateAsUSEndian ( dateObj )
return a simplified Endian formatted date from a date object (mm/dd/yyyy)
ex,
simpletime.getDateAsUSEndian( new Date('Sat Dec 23 2016 17:43:20 GMT-0800 (PST)') ); // '12/23/2015'
getElapsedTimeObj ( bgnDateObj, endDateObj )
return an object whose properties define the elapsed time between date objects
ex,
simpletime.getElapsedTimeObj( new Date('Sun Apr 07 2013 18:08:45 GMT-0700 (PDT)'), new Date('Sun Apr 07 2013 23:59:59 GMT-0700 (PDT)') ); // { ms: 0, sec: 14, min: 51, hour: 5, day: 0 }
getElapsedTimeFormatted ( bgnDateObj, endDateObj )
return a string of the elapsed time between date objects
ex,
simpletime.getElapsedTimeFormatted( new Date('Sun Apr 07 2013 18:08:45 GMT-0700 (PDT)'), new Date('Sun Apr 07 2013 23:59:59 GMT-0700 (PDT)') ); // 051:014:0 (mm:ss:ms)
isDatesInRange ( dateObj1, dateObj2, range )
return true if given dates fall within the same range, specified as "month", "year" or "day"
ex,
simpletime.isDatesInRange( new Date('Sun Apr 07 2013 18:08:45 GMT-0700 (PDT)'), new Date('Sun Apr 07 2013 23:59:59 GMT-0700 (PDT)'), 'day' ); // true simpletime.isDatesInRange( new Date('Sun Apr 07 2013 18:08:45 GMT-0700 (PDT)'), new Date('Sun Apr 08 2013 23:59:59 GMT-0700 (PDT)'), 'day' ); // false
extractDateFormatted ( formattedDateStr, formatStr )
return a date object that is produced from formattedDateStr and the given formatStr
ex,
simpletime.extractDateFormatted( 'April 5, 2013 9:23:41 pm 420', 'MMMM d, y h:mm:ss a z' ); // Fri Apr 05 2013 21:23:41 GMT-0700 (PDT)