ext-date
v1.0.0
Published
Native JavaScript Date object extended with new useful methods.
Downloads
2
Maintainers
Readme
ExtDate
Native JavaScript Date object extended with new useful methods.
- Installation
- Usage
- API
- ExtDate()
- ExtDate.prototype.constructor()
- ExtDate.prototype.getDayOfYear()
- ExtDate.prototype.getUTCDayOfYear()
- ExtDate.prototype.getWeek()
- ExtDate.prototype.getUTCWeek()
- ExtDate.prototype.setDayOfYear()
- ExtDate.prototype.setUTCDayOfYear()
- ExtDate.prototype.setFirstDayOfYear()
- ExtDate.prototype.setUTCFirstDayOfYear()
- ExtDate.prototype.setFirstWeekOfYear()
- ExtDate.prototype.setUTCFirstWeekOfYear()
- ExtDate.prototype.setStartOfDay()
- ExtDate.prototype.setUTCStartOfDay()
- ExtDate.prototype.setWeek()
- ExtDate.prototype.setUTCWeek()
- Brower support
- Support
- Authors and Contributors
- License and copyright
Installation
Via Bower
bower install ext-date
Via NPM
npm install ext-date
Usage
ExtDate is an UMD module. You can load it into your application either by importing the module, or loading the script in your page.
If you are importing the ExtDate module via Webpack, Browserify or similar, make sure that the module name ext-date
is being resolved correctly to the Bower or NPM packages folder.
Via ES6 syntax
import ExtDate from 'ext-date'
Via CommonJS syntax
var ExtDate = require('ext-date')
Via the script tag
<script src="/scripts/ExtDate.js"></script> // Change the path as necessary
API
The ExtDate API tries to mimic the native Date object as much as possible. All the static methods and instance methods available in the native Date object will be available through ExtDate, as long as they are supported by the browser.
For documentation on the native methods, please see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date.
For a consistent behaviour, if ExtDate has any method that also exists in the native Date object, the ExtDate method will take precedence. ExtDate does not modify the native Date object, so you can still access the any native method by using the native Date directly instead of ExtDate.
ExtDate()
Returns a string representation of the current date and time.
Parameters
See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date.
Returns
String A string representation of the current date and time. Equivalent to (new Date().toString())
.
ExtDate.prototype.constructor()
Creates an instance of a Date object extended with the ExtDate methods. The ExtDate constructor uses the same syntax as the native Date object constructor. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date for more details and parameter options.
var dateInstance = new ExtDate()
var dateInstance = new ExtDate('December 17, 1995 03:24:00')
var dateInstance = new ExtDate('1995-12-17T03:24:00')
var dateInstance = new ExtDate(1995, 11, 17)
var dateInstance = new ExtDate(1995, 11, 17, 3, 24, 0)
Parameters
See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date.
Returns
Date A new Date instance extended with the ExtDate methods.
ExtDate.prototype.getDayOfYear()
Returns the day of the year for a specified date according to local time.
var dayfOfYear = dateInstance.getDayOfYear()
Returns
Number The day of the year for the specified date.
ExtDate.prototype.getUTCDayOfYear()
Returns the day of the year for a specified date according to universal time.
var dayfOfYear = dateInstance.getUTCDayOfYear()
Returns
Number The day of the year for the specified date.
ExtDate.prototype.getWeek()
Gets the week number of the specified date according to local time.
var weekNumber = dateInstance.getWeek()
Returns
Number The ISO week number.
ExtDate.prototype.getUTCWeek()
Gets the week number of the specified date according to universal time.
var weekNumber = dateInstance.getUTCWeek()
Returns
Number The ISO week number.
ExtDate.prototype.setDayOfYear(Number day[, Number year])
Sets the day of the year for a specified date according to local time.
dateInstance.setDayOfYear(45, 2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|----------------------|-----------------------|
| day | Number | true
| | An integer between 1 and 365 (or 366, if the year is a leap year) representing the day of the year. |
| year | Number | false
| this.getFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setUTCDayOfYear(Number day[, Number year])
Sets the day of the year for a specified date according to universal time.
dateInstance.setUTCDayOfYear(45, 2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|-------------------------|-----------------------|
| day | Number | true
| | An integer between 1 and 365 (or 366, if the year is a leap year) representing the day of the year. |
| year | Number | false
| this.getUTCFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setFirstDayOfYear([Number year])
Sets the first day of the year for a specified date according to local time.
dateInstance.setFirstDayOfYear(2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|----------------------|----------------------------------|
| year | Number | false
| this.getFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setUTCFirstDayOfYear([Number year])
Sets the first day of the year for a specified date according to universal time.
dateInstance.setUTCFirstDayOfYear(2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|-------------------------|----------------------------------|
| year | Number | false
| this.getUTCFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setFirstWeekOfYear([Number year])
Sets the first day of the first week of the year for a specified date according to local time.
dateInstance.setFirstWeekOfYear(2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|----------------------|----------------------------------|
| year | Number | false
| this.getFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setUTCFirstWeekOfYear([Number year])
Sets the first day of the first week of the year for a specified date according to universal time.
dateInstance.setUTCFirstWeekOfYear(2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|-------------------------|----------------------------------|
| year | Number | false
| this.getUTCFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setStartOfDay()
Sets the time of the day to 00:00:00.000 for a specified date according to local time.
dateInstance.setStartOfDay()
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setUTCStartOfDay()
Sets the time of the day to 00:00:00.000 for a specified date according to universal time.
dateInstance.setUTCStartOfDay()
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setWeek(Number week[, Number year])
Sets the first day of a week number for a specified date according to local time.
dateInstance.setWeek(2, 2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|----------------------|----------------------------------|
| week | Number | true
| | An integer between 1 and 53, representing the week. |
| year | Number | false
| this.getFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
ExtDate.prototype.setUTCWeek(Number week[, Number year])
Sets the first day of a week number for a specified date according to universal time.
dateInstance.setUTCWeek(2, 2016)
Parameters
| Name | Type | Required | Default | Description |
|------|----------|----------|-------------------------|----------------------------------|
| week | Number | true
| | An integer between 1 and 53, representing the week. |
| year | Number | false
| this.getUTCFullYear()
| If not specified, the year of the specified date will remain unchanged. |
Returns
Number The number of milliseconds since 1 January 1970 00:00:00 UTC.
Brower support
ExtDate, although not tested in all of them, was created using features supported by these browsers.
- Android Browser 4+
- Blackberry Browser 7+
- Chrome 13+
- Firefox 4+
- Internet Explorer 9+
- Opera 12+
- Opera Mini 5+
- Safari 7+
Support
If you want to request new features or find any bugs, please open a ticket on the issues page and I'll review it as soon as possible.
Authors and Contributors
Created by Luís Rodrigues (@MrSlide)
License and copyright
Released under the MIT license
Copyright (c) 2016 Luís Rodrigues