Get unlimited public & private packages + team-based management with npm Teams.Learn more »

mockdate

2.0.5 • Public • Published

MockDate

A JavaScript Mock Date object that can be used to change when "now" is.

Build Status

Installation

npm install mockdate

Environment Support

MockDate has been tested in Node, IE9+, Chrome, Firefox, and Opera.

Usage

// CommonJS
var MockDate = require('mockdate');
// AMD
require(['MockDate'], function(MockDate) { ... });
// Script Tag
var MockDate = window.MockDate;

API

MockDate.set(date, [timezoneOffset])

date

date: Object

The Date to be returned when no parameters are passed to new Date(). Supports any object that has a .valueOf method that returns a value that can be passed to new Date().

date: String

The string representation of the date which is passed to the new Date() constructor. This creates the Date to be returned when no parameters are passed to new Date().

date: Number

The millisecond representation of the Date to be returned when no parameters are passed to new Date().

__timezoneOffset

timezoneOffset: Number

The value that should be returned by new Date().getTimezoneOffset()

MockDate.reset();

Will restore the original Date object back to the native implementation.

Example

MockDate.set('2000-11-22');
 
new Date().toString() // "Wed Nov 22 2000 00:00:00 GMT-0600 (CST)"
 
MockDate.set('1/30/2000');
 
new Date().toString() // "Sun Jan 30 2000 00:00:00 GMT-0600 (CST)"
 
MockDate.set('1/30/2000', 120);
 
new Date().getTimezoneOffset() // 120
 
MockDate.set(new Date('2/20/2000'));
 
new Date().toString() // "Sun Feb 20 2000 00:00:00 GMT-0600 (CST)"
 
MockDate.set(moment('3/30/2000')); // using momentjs
 
new Date().toString() // "Thu Mar 30 2000 00:00:00 GMT-0600 (CST)"
 
MockDate.reset();
 
new Date().toString() // "Mon Mar 17 2014 18:08:44 GMT-0500 (CDT)"
new Date().getTimezoneOffset() // 360

Test

npm test

Keywords

Install

npm i mockdate

DownloadsWeekly Downloads

298,098

Version

2.0.5

License

MIT

Unpacked Size

9.85 kB

Total Files

9

Last publish

Collaborators

  • avatar