Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
simpletime
Advanced tools
simpletime - npm Package Compare versions
Comparing version 0.1.22 to 0.1.23
| { | ||
| "name": "simpletime", | ||
| "version": "0.1.22", | ||
| "version": "0.1.23", | ||
| "main": "simpletime", | ||
@@ -5,0 +5,0 @@ "license" : "MIT", |
603
README.md
@@ -25,489 +25,502 @@ simpleTime | ||
| returns a `boolean`, is the given dateObj a valid Date object? | ||
| returns a `boolean`, is the given dateObj a valid Date object? | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.isDateObj(new Date()) // true | ||
| ``` | ||
| ```javascript | ||
| simpletime.isDateObj(new Date()) // true | ||
| ``` | ||
| * **getDateYNum ( _dateObj_ )** | ||
| returns a `number`, the year on the date object. | ||
| returns a `number`, the year on the date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateYNum(new Date()) // 2016 | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateYNum(new Date()) // 2016 | ||
| ``` | ||
| * **getDateYStr ( _dateObj_ )** | ||
| returns a `string`, the year on the date object. | ||
| returns a `string`, the year on the date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateYStr(new Date()) // '2016' | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateYStr(new Date()) // '2016' | ||
| ``` | ||
| * **getDateMNum ( _dateObj_ )** | ||
| returns a `number`, the month on the date object. | ||
| returns a `number`, the month on the date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateMNum(new Date()) // 12 | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateMNum(new Date()) // 12 | ||
| ``` | ||
| * **getDateMStr ( _dateObj_ )** | ||
| returns a `string`, the month on the date object. | ||
| returns a `string`, the month on the date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateMStr(new Date()) // '12' | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateMStr(new Date()) // '12' | ||
| ``` | ||
| * **getDateDNum ( _dateObj_ )** | ||
| returns a `number`, the day on the date object. | ||
| returns a `number`, the day on the date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateDNum(new Date()) // 31 | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateDNum(new Date()) // 31 | ||
| ``` | ||
| * **getDateDStr ( _dateObj_ )** | ||
| returns a `string`, the day on the date object. | ||
| returns a `string`, the day on the date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateDStr(new Date()) // '31' | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateDStr(new Date()) // '31' | ||
| ``` | ||
| * **getDateYMDNumArr ( _dateObj_ )** | ||
| return an array of numbers, the YNum, MNum and DNum of a date object. | ||
| return an array of numbers, the YNum, MNum and DNum of a date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateYMDNumArr(new Date()) // [2016, 12, 31] | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateYMDNumArr(new Date()) // [2016, 12, 31] | ||
| ``` | ||
| * **getDateYMDStrArr ( _dateObj_ )** | ||
| return an array of strings, the YStr, MStr and DStr of a date object. | ||
| return an array of strings, the YStr, MStr and DStr of a date object. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateYMDStrArr(new Date()) // ['2016', '12', '31'] | ||
| ``` | ||
| ```javascript | ||
| simpletime.getDateYMDStrArr(new Date()) // ['2016', '12', '31'] | ||
| ``` | ||
| * **getYMDArrDate ( _ymdArr_ )** | ||
| return a Date object from a YMDNumArr or YMDStrArr | ||
| return a Date object from a YMDNumArr or YMDStrArr | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getYMDArrDate([2016, 12, 31]) // Sat Dec 31 2016 17:43:20 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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. | ||
| return a Date object with given number of minutes added. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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 GMT-0800 (PST) | ||
| simpletime.getMinFromDate(date, 50); // Sat Dec 31 2016 18:33:20 GMT-0800 (PST) | ||
| simpletime.getMinFromDate(date, -5); // Sat Dec 31 2016 17:38:20 GMT-0800 (PST) | ||
| simpletime.getMinFromDate(date, -50); // Sat Dec 31 2016 16:53:20 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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() | ||
| returns a Date object with given number of minutes added to now's new Date() | ||
| ex | ||
| ex | ||
| ```javascript | ||
| simpletime.getMinFromTodayDate(5); // Sat Dec 31 2016 17:48:20 GMT-0800 (PST) | ||
| simpletime.getMinFromTodayDate(50); // Sat Dec 31 2016 18:33:20 GMT-0800 (PST) | ||
| simpletime.getMinFromTodayDate(-5); // Sat Dec 31 2016 17:38:20 GMT-0800 (PST) | ||
| simpletime.getMinFromTodayDate(-50); // Sat Dec 31 2016 16:53:20 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| returns a Date object with given number of days added | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| var date = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); | ||
| ```javascript | ||
| 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 GMT-0800 (PST) | ||
| simpletime.getDayFromDate(date, 50); // Sun Feb 19 2017 17:55:40 GMT-0800 (PST) | ||
| simpletime.getDayFromDate(date, -5); // Mon Dec 26 2016 17:55:40 GMT-0800 (PST) | ||
| simpletime.getDayFromDate(date, -50); // Fri Nov 11 2016 17:55:40 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() | ||
| returns a Date object with given number of days added to now's new Date() | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDayFromTodayDate(5); // Thu Jan 05 2017 17:55:40 GMT-0800 (PST) | ||
| simpletime.getDayFromTodayDate(50); // Sun Feb 19 2017 17:55:40 GMT-0800 (PST) | ||
| simpletime.getDayFromTodayDate(-5); // Mon Dec 26 2016 17:55:40 GMT-0800 (PST) | ||
| simpletime.getDayFromTodayDate(-50); // Fri Nov 11 2016 17:55:40 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| returns a Date object with given number of months added | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| var date = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); | ||
| ```javascript | ||
| 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 GMT-0700 (PDT) | ||
| simpletime.getMonthFromDate(date, 50); // Sun Feb 28 2021 17:58:55 GMT-0800 (PST) | ||
| simpletime.getMonthFromDate(date, -5); // Sun Jul 31 2016 17:58:55 GMT-0700 (PDT) | ||
| simpletime.getMonthFromDate(date, -50); // Wed Oct 31 2012 17:58:55 GMT-0700 (PDT) | ||
| ``` | ||
| 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() | ||
| returns a Date object with given number of months added to now's Date.now() | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getMonthFromTodayDate(5); // Wed May 31 2017 17:58:55 GMT-0700 (PDT) | ||
| simpletime.getMonthFromTodayDate(50); // Sun Feb 28 2021 17:58:55 GMT-0800 (PST) | ||
| simpletime.getMonthFromTodayDate(-5); // Sun Jul 31 2016 17:58:55 GMT-0700 (PDT) | ||
| simpletime.getMonthFromTodayDate(-50); // Wed Oct 31 2012 17:58:55 GMT-0700 (PDT) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| returns a Date object with given number of years added | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| var date = new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)'); | ||
| ```javascript | ||
| 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 GMT-0800 (PST) | ||
| simpletime.getYearFromDate(date, 50); // Fri Dec 31 2066 18:07:54 GMT-0800 (PST) | ||
| simpletime.getYearFromDate(date, -5); // Sat Dec 31 2011 18:07:54 GMT-0800 (PST) | ||
| simpletime.getYearFromDate(date, -50); // Sat Dec 31 1966 18:07:54 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() | ||
| returns a Date object with given number of years added to now's Date.now() | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getYearFromTodayDate(5); // Fri Dec 31 2021 18:07:54 GMT-0800 (PST) | ||
| simpletime.getYearFromTodayDate(50); // Fri Dec 31 2066 18:07:54 GMT-0800 (PST) | ||
| simpletime.getYearFromTodayDate(-5); // Sat Dec 31 2011 18:07:54 GMT-0800 (PST) | ||
| simpletime.getYearFromTodayDate(-50); // Sat Dec 31 1966 18:07:54 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return the number of days found in the give month for the given year | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDaysInMonth(2015, 2); // 28 | ||
| simpletime.getDaysInMonth(2014, 2); // 28 | ||
| simpletime.getDaysInMonth(2013, 2); // 28 | ||
| simpletime.getDaysInMonth(2012, 2); // 29 | ||
| ``` | ||
| ```javascript | ||
| 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. | ||
| return a YMDNumArr with the month value 'fitted' to fall within the range of 1 and 12. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getMFittedYMDNumArr([2015, 2, 2]); // [2015, 2, 2] | ||
| simpletime.getMFittedYMDNumArr([2015, 0, 2]); // [2015, 1, 2] | ||
| simpletime.getMFittedYMDNumArr([2015, 13, 2]); // [2015, 12, 2] | ||
| ``` | ||
| ```javascript | ||
| 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. | ||
| return a YMDNumArr with the day value 'fitted' to fall within the range of days in the given month and year. | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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] | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a date from given dateObj, set to day 1, hour 0, minute 0, second 0, millisecond 0 | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getTimeBgnMonth(new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)')) | ||
| // Thu Dec 01 2016 00:00:00 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a date from given dateObj, set to day last, hour 23, minute 59, second 59, millisecond 999 | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getTimeEndMonth(new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)')) | ||
| // Sat Dec 31 2016 23:59:59 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a date from given dateObj, set to hour 0, minute 0, second 0, millisecond 0 | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getTimeBgnDay(new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)')) | ||
| // Sat Dec 31 2016 00:00:00 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a date from given dateObj, set to hour 23, minute 0, second 0, millisecond 0 | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getTimeEndDay(new Date('Sat Dec 31 2016 17:43:20 GMT-0800 (PST)')) | ||
| // Sat Dec 31 2016 23:59:59 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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? | ||
| return a boolean value, is the date object before given date? | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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 | ||
| ``` | ||
| ```javascript | ||
| 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()? | ||
| return a boolean value, is the date object before date.now()? | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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 | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a date object from a simple ISO formatted string date, format yyyy.mm.dd, yyyy/mm/dd, or yyyy-mm-dd | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.parseISO8601('2016/12/31'); | ||
| // Sat Dec 31 2016 6:43:20 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a date object from a simple endian formatted string date, format mm.dd.yyyy, mm/dd/yyyy, or mm-dd-yyyy | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.parseISO8601('12/31/2016'); | ||
| // Sat Dec 31 2016 6:43:20 GMT-0800 (PST) | ||
| ``` | ||
| ```javascript | ||
| 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. | ||
| 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, | ||
| ex, | ||
| ```javascript | ||
| 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)'); | ||
| ```javascript | ||
| 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) ] | ||
| ``` | ||
| 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. | ||
| 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, | ||
| ex, | ||
| ```javascript | ||
| 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)'); | ||
| ```javascript | ||
| 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) ] | ||
| ``` | ||
| 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][3] formatStr | ||
| return a date that is formatted according to the given [unicode][3] formatStr | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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' | ||
| ``` | ||
| ```javascript | ||
| 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) | ||
| return a simplified ISO formatted date from a date object (yyyy/mm/dd) | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateAsISO(new Date('Sat Dec 23 2016 17:43:20 GMT-0800 (PST)')); | ||
| // '2016/12/23' | ||
| ``` | ||
| ```javascript | ||
| 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) | ||
| return a simplified Endian formatted date from a date object (mm/dd/yyyy) | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| simpletime.getDateAsUSEndian(new Date('Sat Dec 23 2016 17:43:20 GMT-0800 (PST)')); | ||
| // '12/23/2015' | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return an object whose properties define the elapsed time between date objects | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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 } | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a string of the elapsed time between date objects | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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) | ||
| ``` | ||
| ```javascript | ||
| 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" | ||
| return true if given dates fall within the same range, specified as "month", "year" or "day" | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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 | ||
| ``` | ||
| ```javascript | ||
| 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 | ||
| return a date object that is produced from formattedDateStr and the given formatStr | ||
| ex, | ||
| ex, | ||
| ```javascript | ||
| 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) | ||
| ``` | ||
| ```javascript | ||
| 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) | ||
| ``` | ||
@@ -514,0 +527,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.09%
70574
- Number of lines in readme file
- increased by2.46%
542
No dependency changes