hookdate v1.3.1

hookdate

Hook javascript Date object to save date and time for each call, and playback(mock) the saved data to get same result again. Useful for testing.

Install

npm install hookdate

Usage

• Record and playback new Date calls:

var lib = require('hookdate')

lib.start()  //start hook Date object with record mode

var d = [
  new Date(),
  Date(),
  Date.now(),
  new Date(2016, 10, 1)  // this will not record
]

console.log(lib.dateStore)
// [1478515156899, 1478515156000, 1478515156899]

lib.playBack = true

+new Date
// 1478515156899

new Date()
// 1478515156000

Date.now()
// 1478515156899

lib.stop()  //stop hook, restore to old Date object

• Playback new Date with time array:

var lib = require('hookdate')

// OPTIONAL: set timezoneOffset
// CAUTION: this should be set BEFORE lib.hook
lib.timezoneOffset = 60

// set time array, and playBack=true
lib.start([1298937600000, 1478514684440], true)

/* playback first date */
var d = new Date()
d.timezoneOffset()
// 60
d.toISOString()
// "2011-03-01T00:00:00.000Z"

/* pause for a while */
lib.pause = true
new Date()
new Date()

/* continue */
lib.pause = false

/* playback second date */
new Date().toISOString()
// "2016-11-07T10:31:24.440Z"

/* drained, same as normal call */
new Date()
// return system time

// restore old Date object
lib.stop()

API

lib.start :fn( dateStore? :number[], isPlayBack? :boolean, cb? :fn(isPlayback :boolean, value :number) ) => void

Hook global Date object

Optional pass dateStore as time array (milliseconds elapsed since the UNIX epoch), will used for record/playback, default: []

Optional pass whether to playback (true) or record (false), default: false

Optional pass callback to monitor the isPlayBack and value for record/playback.

lib.stop :fn() => void

Restore old global Date object.

lib.dateStore :number[]

Time array (milliseconds elapsed since the UNIX epoch) used for any call to new Date(), Date(), Date.now.

If isPlayBack is true, will shift first value into the Date result, else push new time value into it.

lib.playBack :boolean

Whether the mode is record(false), or a playback(true).

lib.oldDate :Date

The reference of old global Date object.

lib.pause :boolean

When set to true, will pause record/playback, set to false to continue.