sjs/strftime
1
0
Fork 0
mirror of https://github.com/samsonjs/strftime.git synced 2026-04-27 14:57:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

make the CommonJS / Node export backwards compatible

Browse source 
also improves deprecation notices
This commit is contained in:
Sami Samhuri 2015-03-15 14:49:10 -07:00
parent bfe34d92b5
commit c6464d0130
1 changed files with 62 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

81
strftime.js
View file

@ -11,9 +11,7 @@
;(function() { ;(function() {
//// Where to export the API var DefaultLocale = {
var namespace,
DefaultLocale = {
days: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'], days: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
shortDays: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'], shortDays: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'],
months: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'], months: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
@ -34,53 +32,96 @@
x: '%D' x: '%D'
} }
}, },
defaultStrftime = new Strftime(DefaultLocale, 0, false),
defaultStrftime = new Strftime(DefaultLocale, 0, false); isCommonJS = typeof module !== 'undefined',
namespace;
// CommonJS / Node module // CommonJS / Node module
if (typeof module !== 'undefined') { if (isCommonJS) {
namespace = module.exports = defaultStrftime; namespace = module.exports = adaptedStrftime;
namespace.strftime = deprecatedStrftime;
} }
// Browsers and other environments // Browsers and other environments
else { else {
// Get the global object. Works in ES3, ES5, and ES5 strict mode. // Get the global object. Works in ES3, ES5, and ES5 strict mode.
namespace = (function() { return this || (1,eval)('this'); }()); namespace = (function() { return this || (1,eval)('this'); }());
namespace.strftime = adaptedStrftime;
} }
// Deprecated API, to be removed in v1.0 // Deprecated API, to be removed in v1.0
var _require = isCommonJS ? "require('strftime')" : "strftime";
var _deprecationWarnings = {}; var _deprecationWarnings = {};
function deprecationWarning(name, instead) { function deprecationWarning(name, instead) {
if (!_deprecationWarnings[name]) { if (!_deprecationWarnings[name]) {
console.warn("[WARNING] `require('strftime')." + name + "` is deprecated and will be removed in version 1.0. Instead, use `" + instead + "`."); if (typeof console !== 'undefined' && typeof console.warn == 'function') {
console.warn("[WARNING] " + name + " is deprecated and will be removed in version 1.0. Instead, use `" + instead + "`.");
}
_deprecationWarnings[name] = true; _deprecationWarnings[name] = true;
} }
} }
namespace.strftime = function(fmt, d, locale) { namespace.strftimeTZ = deprecatedStrftimeTZ;
deprecationWarning("strftime", "require('strftime')(format, date)` or `require('strftime').localize(locale)(format, date)"); namespace.strftimeUTC = deprecatedStrftimeUTC;
namespace.localizedStrftime = deprecatedStrftimeLocalized;
// Adapt the old API while preserving the new API.
function adaptForwards(fn) {
fn.localize = defaultStrftime.localize.bind(defaultStrftime);
fn.timezone = defaultStrftime.timezone.bind(defaultStrftime);
fn.utc = defaultStrftime.utc.bind(defaultStrftime);
}
adaptForwards(adaptedStrftime);
function adaptedStrftime(fmt, d, locale) {
if (locale) {
deprecationWarning("`" + _require + "(format, date, locale)`", _require + ".localize(locale)(format, [date])");
}
var strftime = locale ? defaultStrftime.localize(locale) : defaultStrftime; var strftime = locale ? defaultStrftime.localize(locale) : defaultStrftime;
return strftime(fmt, d); return strftime(fmt, d);
}; }
namespace.strftimeTZ = function(fmt, d, locale, timezone) { adaptForwards(deprecatedStrftime);
deprecationWarning("strftimeTZ", "require('strftime').timezone(tz)(format, date)` or `require('strftime').timezone(tz).localize(locale)(format, date)"); function deprecatedStrftime(fmt, d, locale) {
if (locale) {
deprecationWarning("`" + _require + ".strftime(format, date, locale)`", _require + ".localize(locale)(format, [date])");
}
else {
deprecationWarning("`" + _require + ".strftime(format, [date])`", _require + "(format, [date])");
}
var strftime = locale ? defaultStrftime.localize(locale) : defaultStrftime;
return strftime(fmt, d);
}
function deprecatedStrftimeTZ(fmt, d, locale, timezone) {
if ((typeof locale == 'number' || typeof locale == 'string') && timezone == null) { if ((typeof locale == 'number' || typeof locale == 'string') && timezone == null) {
timezone = locale; timezone = locale;
locale = undefined; locale = undefined;
} }
var strftime = (locale ? defaultStrftime.localize(locale) : defaultStrftime).timezone(timezone);
if (locale) {
deprecationWarning("`" + _require + ".strftimeTZ(format, date, locale, tz)`", _require + ".timezone(tz).localize(locale)(format, [date])");
}
else {
deprecationWarning("`" + _require + ".strftimeTZ(format, date, tz)`", _require + ".timezone(tz)(format, [date])");
}
var strftime = (locale ? defaultStrftime.timezone(timezone).localize(locale) : defaultStrftime).timezone(timezone);
return strftime(fmt, d); return strftime(fmt, d);
}; };
namespace.strftimeUTC = function(fmt, d, locale) { function deprecatedStrftimeUTC(fmt, d, locale) {
deprecationWarning("strftimeUTC", "require('strftime').utc()(format, date)` or `require('strftime').localize(locale).utc()(format, date)"); if (locale) {
var strftime = (locale ? defaultStrftime.localize(locale) : defaultStrftime).utc(); deprecationWarning("`" + _require + ".strftimeUTC(format, date, locale)`", _require + ".localize(locale).utc()(format, [date])");
}
else {
deprecationWarning("`" + _require + ".strftimeUTC(format, [date])`", _require + ".utc()(format, [date])");
}
var strftime = (locale ? defaultStrftime.utc().localize(locale) : defaultStrftime).utc();
return strftime(fmt, d); return strftime(fmt, d);
}; };
namespace.localizedStrftime = function(locale) { function deprecatedStrftimeLocalized(locale) {
deprecationWarning("localizedStrftime", "require('strftime').localize(locale)"); deprecationWarning("`" + _require + ".localizedStrftime(locale)`", _require + ".localize(locale)");
return defaultStrftime.localize(locale); return defaultStrftime.localize(locale);
}; };
// End of deprecated API // End of deprecated API