dateline
v2.2.4
Published
Associated Press style date & times for JavaScript & Node.js
Downloads
74
Maintainers
Readme
Dateline
Associated Press style date & times
Installation
$ npm install dateline
In the browser
Include dateline.js
to expose Dateline
on the global window
object. Also plays nicely with Browserify + require
, et al.
On the server
var Dateline = require('dateline');
Usage
Pass in a JavaScript Date, get a wrapped Dateline
object back:
var newYears = Dateline(new Date(2014, 0, 1, 0, 0));
// Any valid date will do
var moonWalk = Dateline(new Date(-14159040000));
// Defaults to the current date/time
var now = Dateline();
Call through to native date methods to your heart's content:
moonWalk.getFullYear();
// -> 1969
Dateline adds two methods to the mix:
#getAPTime()
returns an AP-style time string:
newYears.getAPTime();
// -> 'midnight'
moonWalk.getAPTime();
// -> '9:56 p.m.'
Available options:
includeMinutes
: Always include minutes, even at the top of the hour:
// The current time is 11:00 a.m....
Dateline().getAPTime();
// -> '11 a.m.'
Dateline().getAPTime({includeMinutes: true});
// -> '11:00 a.m.'
#getAPDate(options)
returns an AP-style date string:
newYears.getAPDate();
// -> 'Jan. 1'
moonWalk.getAPDate();
// -> 'July 20, 1969'
Available options:
includeYear
: Always include the year, even if it matches the current one:
// Today is August 28, 2014...
Dateline().getAPDate();
// -> 'Aug. 28'
Dateline().getAPDate({includeYear: true});
// -> 'Aug. 28, 2014'
useDayNameForLastWeek
: Use the day of the week for dates in the last seven days:
// Today is June 22, 2009
var myDate = new Date(2009, 5, 20);
Dateline(myDate).getAPDate();
// -> 'June 20'
Dateline(myDate).getAPDate({useDayNameForLastWeek: true});
// -> 'Saturday'