chronokinesis 5.0.2 → 7.0.0

package/README.md

@@ -1,5 +1,5 @@
-chronokinesis
-=============
+# chronokinesis
+
 [![Build](https://github.com/paed01/chronokinesis/actions/workflows/build.yaml/badge.svg)](https://github.com/paed01/chronokinesis/actions/workflows/build.yaml) [![Coverage Status](https://coveralls.io/repos/github/paed01/chronokinesis/badge.svg?branch=master)](https://coveralls.io/github/paed01/chronokinesis?branch=master)
 
 Mock time and date for traveling and freezing. Inspired and borrowed from [timekeeper](https://github.com/vesln/timekeeper).
@@ -13,11 +13,12 @@ Mock time and date for traveling and freezing. Inspired and borrowed from [timek
   - [`defrost()`](#defrost)
   - [`reset()`](#reset)
   - [`isKeepingTime()`](#iskeepingtime)
-  - [`timezone(timeZone)`](#timezonetimezone)
-    - [timezone `freeze([...args])`](#timezone-freezeargs)
-    - [timezone `travel([...args])`](#timezone-travelargs)
-    - [timezone `reset()`](#timezone-reset)
-    - [timezone `defrost()`](#timezone-defrost)
+  - [`timezone(timeZone[, ...args])`](#timezonetimezone-args)
+  - [`new TimeZoneTraveller(timeZone)`](#new-timezonetravellertimezone)
+    - [`timezone.freeze([...args])`](#timezonefreezeargs)
+    - [`timezone.travel([...args])`](#timezonetravelargs)
+    - [`timezone.reset()`](#timezonereset)
+    - [`timezone.defrost()`](#timezonedefrost)
 - [Distributions](#distributions)
   - [Nodejs require](#nodejs-require)
   - [Browser (UMD)](#browser-umd)
@@ -42,6 +43,35 @@ setTimeout(() => {
 }, 2000);
 ```
 
+With arguments:
+
+```javascript
+import * as ck from 'chronokinesis';
+import assert from 'node:assert';
+
+ck.freeze(1980, 0, 1);
+
+assert.equal(true, ck.isKeepingTime());
+assert.deepEqual(new Date(), new Date(1980, 0, 1));
+
+ck.reset();
+```
+
+or use with [`luxon`](https://moment.github.io/luxon):
+
+```javascript
+import { DateTime } from 'luxon';
+import * as ck from 'chronokinesis';
+
+ck.travel(DateTime.now().plus({ year: 1 }).toMillis());
+
+setTimeout(() => {
+  console.log('Traveled with Luxon DateTime one year and some', new Date());
+
+  ck.reset();
+}, 2000);
+```
+
 or use with [`moment`](http://momentjs.com):
 
 ```javascript
@@ -51,8 +81,7 @@ import * as ck from 'chronokinesis';
 ck.travel(moment().add(1, 'year'));
 
 setTimeout(() => {
-  // Date traveled one year and some
-  console.log(new Date());
+  console.log('Traveled with Moment Date one year and some', new Date());
 
   ck.reset();
 }, 2000);
@@ -91,7 +120,7 @@ let date = new Date(2018, 0, 31);
 
 ck.travel(date);
 
-setTimeout(function() {
+setTimeout(function () {
   console.log(new Date());
   ck.reset();
 }, 1500);
@@ -109,7 +138,7 @@ ck.freeze(date);
 
 ck.travel(moment().add(1, 'year'));
 
-setTimeout(function() {
+setTimeout(function () {
   console.log(`Still frozen but one year ahead ${new Date()}`);
 
   ck.reset();
@@ -147,12 +176,12 @@ Resets Date to current glory.
 import * as ck from 'chronokinesis';
 
 ck.freeze(2060, 0, 1);
-console.log(`end of time is reached at ${new Date()} according to Newton`)
+console.log(`end of time is reached at ${new Date()} according to Newton`);
 
 ck.reset();
 
 // Today
-console.log(new Date())
+console.log(new Date());
 ```
 
 ## `isKeepingTime()`
@@ -165,33 +194,60 @@ import * as ck from 'chronokinesis';
 console.log(ck.isKeepingTime() ? 'Is' : 'Not', 'keeping time');
 ck.travel(1893448800000);
 console.log(ck.isKeepingTime() ? 'Is' : 'Not', 'keeping time');
+
+ck.reset();
 ```
 
-## `timezone(timeZone)`
+## `timezone(timeZone[, ...args])`
 
-Freeze and travel in different time zones.
+Travel to time zone.
+
+- `timeZone`: IANA time zone string
+- `...args`: Optional travel to date arguments
+
+Returns [`TimeZoneTraveller` api](#new-timezonetravellertimezone)
 
 ```javascript
 import * as ck from 'chronokinesis';
 
+ck.reset();
+
 const tz = ck.timezone('Asia/Shanghai');
 
+console.log('Now in Shanghai', new Date());
+
 tz.freeze();
+
+ck.reset();
+```
+
+## `new TimeZoneTraveller(timeZone)`
+
+Time zone traveller api.
+
+```javascript
+import { TimeZoneTraveller, reset } from 'chronokinesis';
+
+const timezone = new TimeZoneTraveller('Asia/Shanghai');
+
+timezone.freeze();
+
+reset();
 ```
 
-### timezone `freeze([...args])`
+### `timezone.freeze([...args])`
 
 Freeze at the specific timezone.
 
-### timezone `travel([...args])`
+### `timezone.travel([...args])`
 
 Start traveling in the specific timezone.
 
-### timezone `reset()`
+### `timezone.reset()`
 
 Same as [#reset](#reset)
 
-### timezone `defrost()`
+### `timezone.defrost()`
 
 Same as [#defrost](#defrost)
 

package/dist/chronokinesis.cjs

@@ -10,7 +10,9 @@
    * Veselin Todorov <hi@vesln.com>
    * MIT License.
    */
-  const NativeDate = Date;
+  const kNativeDate = Symbol.for('chronokinesis native date');
+
+  const NativeDate = Date[kNativeDate] || Date;
   const nativeGetTimezoneOffset = NativeDate.prototype.getTimezoneOffset;
 
   let freezedAt = null;
@@ -33,7 +35,7 @@
         const curr = nativeGetTimezoneOffset.call(this);
         if (!iana) return curr;
 
-        const tz = timezone(iana).getTime(this);
+        const tz = new TimeZoneTraveller(iana).getTime(this);
         return Math.round((tz - this.getTime()) / 60000) + curr;
       },
     });
@@ -41,12 +43,14 @@
     return dt;
   }
 
+  FakeDate[kNativeDate] = NativeDate;
+
   FakeDate.UTC = NativeDate.UTC;
   FakeDate.parse = NativeDate.parse;
 
   FakeDate.prototype = NativeDate.prototype;
 
-  FakeDate.now = function() {
+  FakeDate.now = function fakeNow() {
     if (freezedAt) return freezedAt.getTime();
     return time();
   };
@@ -95,7 +99,8 @@
     return Date === FakeDate;
   }
 
-  function timezone(timeZone) {
+  function TimeZoneTraveller(timeZone) {
+    this.timeZone = timeZone;
     const options = {
       year: 'numeric',
       month: 'numeric',
@@ -105,52 +110,51 @@
       second: 'numeric',
       hour12: false,
     };
-
-    const current = Intl.DateTimeFormat('UTC', options);
-    const formatter = Intl.DateTimeFormat('UTC', {
-      timeZone: timeZone,
+    this.localFormatter = Intl.DateTimeFormat('UTC', options);
+    this.timeZoneFormatter = Intl.DateTimeFormat('UTC', {
+      timeZone,
       ...options,
     });
+  }
 
-    return {
-      timeZone,
-      defrost,
-      reset,
-      isKeepingTime,
-      getTime,
-      freeze: freezeInTimezone,
-      travel: travelInTimezone,
-    };
+  TimeZoneTraveller.prototype.defrost = defrost;
+  TimeZoneTraveller.prototype.reset = reset;
+  TimeZoneTraveller.prototype.isKeepingTime = isKeepingTime;
 
-    function freezeInTimezone(...args) {
-      if (!args.length && iana === timeZone) return freeze();
-      iana = timeZone;
-      return freeze(getTime(...args));
-    }
+  TimeZoneTraveller.prototype.getTime = function timeZoneGetTime(...args) {
+    const realDate = instantiate(Date, args);
+    const tz = new NativeDate(toUTC(this.timeZoneFormatter, realDate));
 
-    function travelInTimezone(...args) {
-      if (!args.length && iana === timeZone) return travel();
-      iana = timeZone;
-      return travel(getTime(...args));
-    }
+    if (!args.length) return tz.getTime();
+    const currentTz = new NativeDate(toUTC(this.localFormatter, realDate));
 
-    function getTime(...args) {
-      const realDate = instantiate(Date, args);
-      const tz = new NativeDate(toUTC(formatter, realDate));
+    return realDate.getTime() + currentTz.getTime() - tz.getTime();
+  };
 
-      if (!args.length) return tz.getTime();
-      const currentTz = new NativeDate(toUTC(current, realDate));
+  TimeZoneTraveller.prototype.freeze = function freezeInTimezone(...args) {
+    if (!args.length && iana === this.timeZone) return freeze();
+    iana = this.timeZone;
+    return freeze(this.getTime(...args));
+  };
 
-      return realDate.getTime() + currentTz.getTime() - tz.getTime();
-    }
+  TimeZoneTraveller.prototype.travel = function timeZoneTravel(...args) {
+    if (!args.length && iana === this.timeZone) return travel();
+    iana = this.timeZone;
+    return travel(this.getTime(...args));
+  };
+
+  function timezone(timeZone, ...args) {
+    const tz = new TimeZoneTraveller(timeZone);
+    tz.travel(...args);
+    return tz;
   }
 
   function useFakeDate() {
-    Date = FakeDate; // eslint-disable-line no-global-assign
+    Date = FakeDate;
   }
 
   function useNativeDate() {
-    Date = NativeDate; // eslint-disable-line no-global-assign
+    Date = FakeDate[kNativeDate];
   }
 
   function time() {
@@ -166,7 +170,7 @@
   function toUTC(formatter, dt) {
     let year, month, day, hour, minute, second;
 
-    for (const {type, value} of formatter.formatToParts(dt)) {
+    for (const { type, value } of formatter.formatToParts(dt)) {
       switch (type) {
         case 'year':
           year = parseInt(value);
@@ -192,6 +196,8 @@
     return NativeDate.UTC(year, month, day, hour, minute, second, dt.getMilliseconds());
   }
 
+  exports.FakeDate = FakeDate;
+  exports.TimeZoneTraveller = TimeZoneTraveller;
   exports.defrost = defrost;
   exports.freeze = freeze;
   exports.isKeepingTime = isKeepingTime;

package/dist/index.cjs

@@ -6,7 +6,9 @@
  * Veselin Todorov <hi@vesln.com>
  * MIT License.
  */
-const NativeDate = Date;
+const kNativeDate = Symbol.for('chronokinesis native date');
+
+const NativeDate = Date[kNativeDate] || Date;
 const nativeGetTimezoneOffset = NativeDate.prototype.getTimezoneOffset;
 
 let freezedAt = null;
@@ -29,7 +31,7 @@ function FakeDate(...args) {
       const curr = nativeGetTimezoneOffset.call(this);
       if (!iana) return curr;
 
-      const tz = timezone(iana).getTime(this);
+      const tz = new TimeZoneTraveller(iana).getTime(this);
       return Math.round((tz - this.getTime()) / 60000) + curr;
     },
   });
@@ -37,12 +39,14 @@ function FakeDate(...args) {
   return dt;
 }
 
+FakeDate[kNativeDate] = NativeDate;
+
 FakeDate.UTC = NativeDate.UTC;
 FakeDate.parse = NativeDate.parse;
 
 FakeDate.prototype = NativeDate.prototype;
 
-FakeDate.now = function() {
+FakeDate.now = function fakeNow() {
   if (freezedAt) return freezedAt.getTime();
   return time();
 };
@@ -91,7 +95,8 @@ function isKeepingTime() {
   return Date === FakeDate;
 }
 
-function timezone(timeZone) {
+function TimeZoneTraveller(timeZone) {
+  this.timeZone = timeZone;
   const options = {
     year: 'numeric',
     month: 'numeric',
@@ -101,52 +106,51 @@ function timezone(timeZone) {
     second: 'numeric',
     hour12: false,
   };
-
-  const current = Intl.DateTimeFormat('UTC', options);
-  const formatter = Intl.DateTimeFormat('UTC', {
-    timeZone: timeZone,
+  this.localFormatter = Intl.DateTimeFormat('UTC', options);
+  this.timeZoneFormatter = Intl.DateTimeFormat('UTC', {
+    timeZone,
     ...options,
   });
+}
 
-  return {
-    timeZone,
-    defrost,
-    reset,
-    isKeepingTime,
-    getTime,
-    freeze: freezeInTimezone,
-    travel: travelInTimezone,
-  };
+TimeZoneTraveller.prototype.defrost = defrost;
+TimeZoneTraveller.prototype.reset = reset;
+TimeZoneTraveller.prototype.isKeepingTime = isKeepingTime;
 
-  function freezeInTimezone(...args) {
-    if (!args.length && iana === timeZone) return freeze();
-    iana = timeZone;
-    return freeze(getTime(...args));
-  }
+TimeZoneTraveller.prototype.getTime = function timeZoneGetTime(...args) {
+  const realDate = instantiate(Date, args);
+  const tz = new NativeDate(toUTC(this.timeZoneFormatter, realDate));
 
-  function travelInTimezone(...args) {
-    if (!args.length && iana === timeZone) return travel();
-    iana = timeZone;
-    return travel(getTime(...args));
-  }
+  if (!args.length) return tz.getTime();
+  const currentTz = new NativeDate(toUTC(this.localFormatter, realDate));
 
-  function getTime(...args) {
-    const realDate = instantiate(Date, args);
-    const tz = new NativeDate(toUTC(formatter, realDate));
+  return realDate.getTime() + currentTz.getTime() - tz.getTime();
+};
 
-    if (!args.length) return tz.getTime();
-    const currentTz = new NativeDate(toUTC(current, realDate));
+TimeZoneTraveller.prototype.freeze = function freezeInTimezone(...args) {
+  if (!args.length && iana === this.timeZone) return freeze();
+  iana = this.timeZone;
+  return freeze(this.getTime(...args));
+};
 
-    return realDate.getTime() + currentTz.getTime() - tz.getTime();
-  }
+TimeZoneTraveller.prototype.travel = function timeZoneTravel(...args) {
+  if (!args.length && iana === this.timeZone) return travel();
+  iana = this.timeZone;
+  return travel(this.getTime(...args));
+};
+
+function timezone(timeZone, ...args) {
+  const tz = new TimeZoneTraveller(timeZone);
+  tz.travel(...args);
+  return tz;
 }
 
 function useFakeDate() {
-  Date = FakeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate;
 }
 
 function useNativeDate() {
-  Date = NativeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate[kNativeDate];
 }
 
 function time() {
@@ -162,7 +166,7 @@ function instantiate(type, args) {
 function toUTC(formatter, dt) {
   let year, month, day, hour, minute, second;
 
-  for (const {type, value} of formatter.formatToParts(dt)) {
+  for (const { type, value } of formatter.formatToParts(dt)) {
     switch (type) {
       case 'year':
         year = parseInt(value);
@@ -188,6 +192,8 @@ function toUTC(formatter, dt) {
   return NativeDate.UTC(year, month, day, hour, minute, second, dt.getMilliseconds());
 }
 
+exports.FakeDate = FakeDate;
+exports.TimeZoneTraveller = TimeZoneTraveller;
 exports.defrost = defrost;
 exports.freeze = freeze;
 exports.isKeepingTime = isKeepingTime;

package/index.d.ts

@@ -22,11 +22,21 @@ export function reset(): void;
  */
 export function isKeepingTime(): boolean;
 
+/**
+ * Fake date
+ */
+export class FakeDate extends Date {}
+
 /**
  * Timezone traveling
  */
-interface TimezoneTraveling {
-  /** Timezone */
+export class TimeZoneTraveller {
+  /**
+   *
+   * @param timeZone IANA time zone
+   */
+  constructor(timeZone: string);
+  /** IANA time zone */
   readonly timeZone: string;
   defrost: typeof defrost;
   reset: typeof reset;
@@ -38,11 +48,12 @@ interface TimezoneTraveling {
    * @param args Same arguments as Date constructor.
    * @returns number of milliseconds since the epoch (January 1, 1970, UTC)
    */
-  getTime: (...args: any[]) => number;
+  getTime(...args: any[]): number;
 }
 
 /**
- * Freeze and travel in different time zones.
- * @param timeZone
+ * Travel to time zone.
+ * @param timeZone IANA time zone
+ * @param args Optional travel to date arguments
  */
-export function timezone(timeZone: string): TimezoneTraveling;
+export function timezone(timeZone: string, ...args: any[]): TimeZoneTraveller;

package/index.js

@@ -4,7 +4,9 @@
  * Veselin Todorov <hi@vesln.com>
  * MIT License.
  */
-const NativeDate = Date;
+const kNativeDate = Symbol.for('chronokinesis native date');
+
+const NativeDate = Date[kNativeDate] || Date;
 const nativeGetTimezoneOffset = NativeDate.prototype.getTimezoneOffset;
 
 let freezedAt = null;
@@ -12,7 +14,7 @@ let traveledTo = null;
 let started = null;
 let iana = null;
 
-function FakeDate(...args) {
+export function FakeDate(...args) {
   const length = args.length;
   if (!length) {
     if (freezedAt) args = [freezedAt];
@@ -27,7 +29,7 @@ function FakeDate(...args) {
       const curr = nativeGetTimezoneOffset.call(this);
       if (!iana) return curr;
 
-      const tz = timezone(iana).getTime(this);
+      const tz = new TimeZoneTraveller(iana).getTime(this);
       return Math.round((tz - this.getTime()) / 60000) + curr;
     },
   });
@@ -35,12 +37,14 @@ function FakeDate(...args) {
   return dt;
 }
 
+FakeDate[kNativeDate] = NativeDate;
+
 FakeDate.UTC = NativeDate.UTC;
 FakeDate.parse = NativeDate.parse;
 
 FakeDate.prototype = NativeDate.prototype;
 
-FakeDate.now = function() {
+FakeDate.now = function fakeNow() {
   if (freezedAt) return freezedAt.getTime();
   return time();
 };
@@ -89,7 +93,8 @@ export function isKeepingTime() {
   return Date === FakeDate;
 }
 
-export function timezone(timeZone) {
+export function TimeZoneTraveller(timeZone) {
+  this.timeZone = timeZone;
   const options = {
     year: 'numeric',
     month: 'numeric',
@@ -99,52 +104,51 @@ export function timezone(timeZone) {
     second: 'numeric',
     hour12: false,
   };
-
-  const current = Intl.DateTimeFormat('UTC', options);
-  const formatter = Intl.DateTimeFormat('UTC', {
-    timeZone: timeZone,
+  this.localFormatter = Intl.DateTimeFormat('UTC', options);
+  this.timeZoneFormatter = Intl.DateTimeFormat('UTC', {
+    timeZone,
     ...options,
   });
+}
 
-  return {
-    timeZone,
-    defrost,
-    reset,
-    isKeepingTime,
-    getTime,
-    freeze: freezeInTimezone,
-    travel: travelInTimezone,
-  };
+TimeZoneTraveller.prototype.defrost = defrost;
+TimeZoneTraveller.prototype.reset = reset;
+TimeZoneTraveller.prototype.isKeepingTime = isKeepingTime;
 
-  function freezeInTimezone(...args) {
-    if (!args.length && iana === timeZone) return freeze();
-    iana = timeZone;
-    return freeze(getTime(...args));
-  }
+TimeZoneTraveller.prototype.getTime = function timeZoneGetTime(...args) {
+  const realDate = instantiate(Date, args);
+  const tz = new NativeDate(toUTC(this.timeZoneFormatter, realDate));
 
-  function travelInTimezone(...args) {
-    if (!args.length && iana === timeZone) return travel();
-    iana = timeZone;
-    return travel(getTime(...args));
-  }
+  if (!args.length) return tz.getTime();
+  const currentTz = new NativeDate(toUTC(this.localFormatter, realDate));
 
-  function getTime(...args) {
-    const realDate = instantiate(Date, args);
-    const tz = new NativeDate(toUTC(formatter, realDate));
+  return realDate.getTime() + currentTz.getTime() - tz.getTime();
+};
 
-    if (!args.length) return tz.getTime();
-    const currentTz = new NativeDate(toUTC(current, realDate));
+TimeZoneTraveller.prototype.freeze = function freezeInTimezone(...args) {
+  if (!args.length && iana === this.timeZone) return freeze();
+  iana = this.timeZone;
+  return freeze(this.getTime(...args));
+};
 
-    return realDate.getTime() + currentTz.getTime() - tz.getTime();
-  }
+TimeZoneTraveller.prototype.travel = function timeZoneTravel(...args) {
+  if (!args.length && iana === this.timeZone) return travel();
+  iana = this.timeZone;
+  return travel(this.getTime(...args));
+};
+
+export function timezone(timeZone, ...args) {
+  const tz = new TimeZoneTraveller(timeZone);
+  tz.travel(...args);
+  return tz;
 }
 
 function useFakeDate() {
-  Date = FakeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate;
 }
 
 function useNativeDate() {
-  Date = NativeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate[kNativeDate];
 }
 
 function time() {
@@ -160,7 +164,7 @@ function instantiate(type, args) {
 function toUTC(formatter, dt) {
   let year, month, day, hour, minute, second;
 
-  for (const {type, value} of formatter.formatToParts(dt)) {
+  for (const { type, value } of formatter.formatToParts(dt)) {
     switch (type) {
       case 'year':
         year = parseInt(value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chronokinesis",
-  "version": "5.0.2",
+  "version": "7.0.0",
   "description": "Module for testing time-dependent code",
   "author": {
     "name": "Pål Edman",
@@ -15,14 +15,20 @@
   "sideEffects": true,
   "repository": {
     "type": "git",
-    "url": "git://github.com/paed01/chronokinesis"
+    "url": "git://github.com/paed01/chronokinesis.git"
+  },
+  "exports": {
+    "import": "./index.js",
+    "require": "./dist/index.cjs",
+    "types": "./index.d.ts"
   },
   "scripts": {
     "toc": "node generate-api-toc.cjs",
     "test": "mocha",
-    "lint": "eslint . --cache",
+    "lint": "eslint . --cache && prettier . --check --cache",
     "test:lcov": "c8 -r lcov -r text mocha && npm run lint",
-    "posttest": "npm run lint && npm run dist",
+    "cov:html": "c8 mocha -R dot && c8 report --reporter html",
+    "posttest": "npm run lint && npm run dist && texample -g",
     "prepack": "npm run dist",
     "dist": "npm run toc && rollup -c"
   },
@@ -48,14 +54,17 @@
     "fake now"
   ],
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^24.0.1",
-    "c8": "^7.12.0",
-    "chai": "^4.3.7",
-    "eslint": "^8.29.0",
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "c8": "^10.1.2",
+    "chai": "^5.1.0",
+    "eslint": "^9.3.0",
     "lodash.clonedeep": "^4.5.0",
+    "luxon": "^3.7.1",
     "markdown-toc": "^1.2.0",
-    "mocha": "^10.1.0",
-    "moment": "^2.29.4",
-    "rollup": "^3.7.0"
+    "mocha": "^11.0.1",
+    "moment": "^2.30.1",
+    "prettier": "^3.2.5",
+    "rollup": "^4.12.1",
+    "texample": "^0.0.8"
   }
 }