time-machine-js 1.0.0 → 1.1.0

package/README.md

@@ -18,7 +18,7 @@ npm install time-machine-js
 
 ## API
 
-The core API consists of four main functions:
+The core API consists of five main functions:
 
 ### `travel(timestamp: number, mode: 'flowing' | 'frozen'): void`
 Moves the environment time to the specified Unix timestamp.
@@ -34,6 +34,9 @@ Returns the current offset in ms (flowing mode) or the frozen timestamp (frozen
 ### `isActive(): boolean`
 Returns `true` if the time machine is currently active.
 
+### `getMode(): 'flowing' | 'frozen' | null`
+Returns the current mode of the time machine, or `null` if inactive.
+
 ## Persistence (Browser Only)
 
 For environments with `localStorage`, you can manually save and restore the time machine state across page reloads:

package/dist/index.d.mts

@@ -31,6 +31,12 @@ declare function getOffset(): number | null;
  * @returns True if active, false otherwise.
  */
 declare function isActive(): boolean;
+/**
+ * Returns the current mode of the time machine.
+ *
+ * @returns 'flowing', 'frozen', or null if inactive.
+ */
+declare function getMode(): TimeMachineMode | null;
 /**
  * Saves the current time machine state to localStorage (browser only).
  *
@@ -45,4 +51,4 @@ declare function save(storageKey?: string): void;
  */
 declare function restore(storageKey?: string): boolean;
 
-export { type TimeMachineMode, getOffset, isActive, restore, returnToPresent, save, travel };
+export { type TimeMachineMode, getMode, getOffset, isActive, restore, returnToPresent, save, travel };

package/dist/index.d.ts

@@ -31,6 +31,12 @@ declare function getOffset(): number | null;
  * @returns True if active, false otherwise.
  */
 declare function isActive(): boolean;
+/**
+ * Returns the current mode of the time machine.
+ *
+ * @returns 'flowing', 'frozen', or null if inactive.
+ */
+declare function getMode(): TimeMachineMode | null;
 /**
  * Saves the current time machine state to localStorage (browser only).
  *
@@ -45,4 +51,4 @@ declare function save(storageKey?: string): void;
  */
 declare function restore(storageKey?: string): boolean;
 
-export { type TimeMachineMode, getOffset, isActive, restore, returnToPresent, save, travel };
+export { type TimeMachineMode, getMode, getOffset, isActive, restore, returnToPresent, save, travel };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  getMode: () => getMode,
   getOffset: () => getOffset,
   isActive: () => isActive,
   restore: () => restore,
@@ -62,6 +63,9 @@ function getOffset() {
 function isActive() {
   return state.isActive;
 }
+function getMode() {
+  return state.mode;
+}
 function save(storageKey = "__timeMachine__") {
   if (typeof localStorage === "undefined" || !state.isActive) return;
   const savedState = {
@@ -89,6 +93,7 @@ function restore(storageKey = "__timeMachine__") {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  getMode,
   getOffset,
   isActive,
   restore,

package/dist/index.mjs

@@ -33,6 +33,9 @@ function getOffset() {
 function isActive() {
   return state.isActive;
 }
+function getMode() {
+  return state.mode;
+}
 function save(storageKey = "__timeMachine__") {
   if (typeof localStorage === "undefined" || !state.isActive) return;
   const savedState = {
@@ -59,6 +62,7 @@ function restore(storageKey = "__timeMachine__") {
   }
 }
 export {
+  getMode,
   getOffset,
   isActive,
   restore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "time-machine-js",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A zero-dependency utility to monkey-patch Date.now() globally.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -28,6 +28,14 @@
     "date",
     "manipulation"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WilliamPinto-Olmos/time-machine-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/WilliamPinto-Olmos/time-machine-js/issues"
+  },
+  "homepage": "https://github.com/WilliamPinto-Olmos/time-machine-js#readme",
   "author": "",
   "license": "MIT",
   "devDependencies": {