@opengeoweb/metronome 16.0.0 → 17.0.0

package/index.esm.js

@@ -53,6 +53,10 @@ function _unsupportedIterableToArray(r, a) {
  */
 var Metronome = /*#__PURE__*/function () {
   function Metronome() {
+    this.tickId = void 0;
+    this.timers = void 0;
+    this.interval = void 0;
+    this.handleTimerTicks = void 0;
     this.tickId = 0;
     this.step = this.step.bind(this);
     this.isPaused = this.isPaused.bind(this);
@@ -100,6 +104,7 @@ var Metronome = /*#__PURE__*/function () {
       (_this$handleTimerTick = this.handleTimerTicks) == null || _this$handleTimerTick.call(this, triggeredTimerIds);
     }
   }
+
   /**
    * Multiple timers with varying frequencies can be made at the same
    * time however each timerId must be unique. If you attempt to create
@@ -127,6 +132,7 @@ var Metronome = /*#__PURE__*/function () {
     });
     return this.timers.at(-1);
   }
+
   /**
    * Unregistering a timer completely removes it, if you want to pause a
    * timer, then use pauseTimer()
@@ -141,6 +147,7 @@ var Metronome = /*#__PURE__*/function () {
       this.timers.splice(indexToRemove, 1);
     }
   }
+
   /**
    * Checks if a timer is paused
    *
@@ -156,6 +163,7 @@ var Metronome = /*#__PURE__*/function () {
     }
     return false;
   }
+
   /**
    * Continues running a timer
    *
@@ -170,6 +178,7 @@ var Metronome = /*#__PURE__*/function () {
       }
     }
   }
+
   /**
    * Pauses a timer
    *
@@ -184,6 +193,7 @@ var Metronome = /*#__PURE__*/function () {
       }
     }
   }
+
   /**
    * Toggles a timer to be paused or running. Be careful when asking redux
    * to toggle a timer, it might toggle twice and therefore do nothing
@@ -199,6 +209,7 @@ var Metronome = /*#__PURE__*/function () {
       }
     }
   }
+
   /**
    * Sets the speed of a timer to a new frequency given in hertz
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/metronome",
-  "version": "16.0.0",
+  "version": "17.0.0",
   "description": "GeoWeb metronome library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
   },
   "devDependencies": {
-    "eslint-plugin-storybook": "9.0.17"
+    "eslint-plugin-storybook": "10.3.3"
   },
   "dependencies": {},
   "module": "./index.esm.js",

package/src/index.d.ts

@@ -1 +0,0 @@
-export { metronome } from './lib/metronome';

package/src/lib/metronome.d.ts

@@ -1,76 +0,0 @@
-type TimerFunction = (timerId: string, tickId: number) => void;
-interface Timer {
-    timerFunc: TimerFunction | null;
-    hertz: number;
-    timerId: string;
-    isPaused: boolean;
-}
-/**
- * This class should NEVER be initialized with new Metronome(). Use the
- * exported variable. To reset the metronome use unregisterAllTimers()
- * to remove all existing timers followed by init() to initialize the
- * ticks.
- */
-declare class Metronome {
-    tickId: number;
-    timers: Timer[];
-    interval: NodeJS.Timeout | null;
-    handleTimerTicks: ((timerIds: string[]) => void) | null;
-    constructor();
-    init(): void;
-    unregisterAllTimers(): void;
-    step(): void;
-    /**
-     * Multiple timers with varying frequencies can be made at the same
-     * time however each timerId must be unique. If you attempt to create
-     * two timers with the same timerId, the second will silently be ignored.
-     *
-     * @param timerFunc The function to be executed at the given hertz frequency
-     * @param hertz Frequency of the timer given in hertz
-     * @param timerId Id of the timer
-     * @returns Timer or nothing if no timer was created
-     */
-    register(timerFunc: TimerFunction | null, hertz: number, timerId: string): Timer | undefined;
-    /**
-     * Unregistering a timer completely removes it, if you want to pause a
-     * timer, then use pauseTimer()
-     *
-     * @param timerId Id of the timer
-     */
-    unregister(timerId: string): void;
-    /**
-     * Checks if a timer is paused
-     *
-     * @param timerId Id of the timer
-     * @returns true if the timer is paused, false if it is running
-     */
-    isPaused(timerId: string): boolean;
-    /**
-     * Continues running a timer
-     *
-     * @param timerId Id of the timer
-     */
-    continueTimer(timerId: string): void;
-    /**
-     * Pauses a timer
-     *
-     * @param timerId Id of the timer
-     */
-    pauseTimer(timerId: string): void;
-    /**
-     * Toggles a timer to be paused or running. Be careful when asking redux
-     * to toggle a timer, it might toggle twice and therefore do nothing
-     *
-     * @param timerId Id of the timer
-     */
-    toggleTimer(timerId: string): void;
-    /**
-     * Sets the speed of a timer to a new frequency given in hertz
-     *
-     * @param timerId Id of the timer
-     * @param hertz Frequency of the timer given in hertz
-     */
-    setSpeed(timerId: string, hertz: number): void;
-}
-declare const metronome: Metronome;
-export { metronome };

package/src/lib/metronome.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/src/lib/metronome.stories.d.ts

@@ -1,7 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react-webpack5';
-import { metronome } from './metronome';
-declare const meta: Meta<typeof metronome>;
-export default meta;
-type Story = StoryObj<typeof metronome>;
-export declare const MetronomeCanvasPlaygroundDemo: Story;
-export declare const MetronomeCanvasDemo: Story;