dateonly
A JavaScript class that stores a date without a time.
About
DateOnly
is a data type that will only store a date, without an associated time. This allows you to work with dates without having to worry about time zones shifting the date.
A simple example is a person's birthday - a birthday is not a single moment in time, but rather a full day. DateOnly
is the perfect data type to represent such data.
Installation
npm install dateonly
Usage
// CommonJSvar DateOnly = ;
// AMD;
// Script Tagvar DateOnly = windowDateOnly;
var DateOnly = ;var myBirthday = '7/4/1980';
API
defaultValue
defaultValue: undefined
If nothing is passed into the DateOnly
constructor, it will default to today's date.
defaultValue: Date
If a Date
object is passed in, the DateOnly
instance will be set to the Date
's date.
defaultValue: String
If a String
is passed in, it will be passed to the Date
constructor, and that new Date
instance will then be used to set the DateOnly
's date.
defaultValue: Number
If a Number
is passed in, it will be passed to the Date
constructor, and that new Date
instance will then be used to set the DateOnly
's date.
Sets the date
portion of the DateOnly
instance.
date: Number
The number to set the date to. No validation is performed.
Example:
var date = '1/1/2000';date;console; // { date: 20, month: 0, year: 2000 }date;console; // { date: 80, month: 0, year: 2000 }
Gets the date
portion of the DateOnly
instance.
Sets the month
portion of the DateOnly
instance. As with the Date
object, January === 0.
month: Number
The number to set the month to. No validation is performed.
Gets the year
portion of the DateOnly
instance.
Sets the year
portion of the DateOnly
instance.
month: Number
The number to set the year to. No validation is performed.
Gets the year
portion of the DateOnly
instance.
Gets the day of the week of the DateOnly
instance. As with the Date
object, Sunday === 0.
Returns the Date
representation of the DateOnly
instance.
Example:
var dateOnly = '1/1/2000';dateOnly instanceof Date // truedateOnly; // Sat Jan 01 2000 00:00:00 GMT-0600 (CST)
|
Returns the numeric representation of the DateOnly
instance, of the form YYYYMMDD
.
Example:
var dateOnly = '7/15/2000';dateOnly // 20000615dateOnly // 20000615
Returns the date string of the DateOnly
instance. This is equivalent to calling new DateOnly().toDate().toDateString()
.
Example:
var dateOnly = '7/4/2000';dateOnly // 'Tue Jul 04 2000'
If you are using Mongo and Mongoose, there is a package that will allow you to store and query DateOnly
properties that can be found here.
Test
npm test