@opengeoweb/metronome 9.28.1 → 9.29.0

package/index.esm.js

@@ -1729,28 +1729,28 @@ for (var COLLECTION_NAME in DOMIterables) {
 
 handlePrototype(DOMTokenListPrototype, 'DOMTokenList');
 
-/* *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * Copyright 2024 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
- * Copyright 2024 - Finnish Meteorological Institute (FMI)
- * Copyright 2024 - The Norwegian Meteorological Institute (MET Norway)
+/* *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright 2024 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2024 - Finnish Meteorological Institute (FMI)
+ * Copyright 2024 - The Norwegian Meteorological Institute (MET Norway)
  * */
-/**
- * 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.
+/**
+ * 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.
  */
 class Metronome {
   constructor() {
@@ -1798,15 +1798,15 @@ class Metronome {
       this.handleTimerTicks && this.handleTimerTicks(triggeredTimerIds);
     }
   }
-  /**
-   * 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
+  /**
+   * 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, hertz, timerId) {
     const existingTimer = this.timers.find(timer => timer.timerId === timerId);
@@ -1823,11 +1823,11 @@ class Metronome {
     });
     return this.timers.at(-1);
   }
-  /**
-   * Unregistering a timer completely removes it, if you want to pause a
-   * timer, then use pauseTimer()
-   *
-   * @param timerId Id of the timer
+  /**
+   * Unregistering a timer completely removes it, if you want to pause a
+   * timer, then use pauseTimer()
+   *
+   * @param timerId Id of the timer
    */
   unregister(timerId) {
     const indexToRemove = this.timers.findIndex(timer => timer.timerId === timerId);
@@ -1835,11 +1835,11 @@ class Metronome {
       this.timers.splice(indexToRemove, 1);
     }
   }
-  /**
-   * Checks if a timer is paused
-   *
-   * @param timerId Id of the timer
-   * @returns true if the timer is paused, false if it is running
+  /**
+   * 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) {
     for (const timer of this.timers) {
@@ -1849,10 +1849,10 @@ class Metronome {
     }
     return false;
   }
-  /**
-   * Continues running a timer
-   *
-   * @param timerId Id of the timer
+  /**
+   * Continues running a timer
+   *
+   * @param timerId Id of the timer
    */
   continueTimer(timerId) {
     for (const timer of this.timers) {
@@ -1862,10 +1862,10 @@ class Metronome {
       }
     }
   }
-  /**
-   * Pauses a timer
-   *
-   * @param timerId Id of the timer
+  /**
+   * Pauses a timer
+   *
+   * @param timerId Id of the timer
    */
   pauseTimer(timerId) {
     for (const timer of this.timers) {
@@ -1875,11 +1875,11 @@ class Metronome {
       }
     }
   }
-  /**
-   * 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
+  /**
+   * 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) {
     for (const timer of this.timers) {
@@ -1889,11 +1889,11 @@ class Metronome {
       }
     }
   }
-  /**
-   * 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
+  /**
+   * 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, hertz) {
     for (const timer of this.timers) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/metronome",
-  "version": "9.28.1",
+  "version": "9.29.0",
   "description": "GeoWeb metronome library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {

package/src/index.d.ts

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

package/src/lib/metronome.d.ts

@@ -1,77 +1,77 @@
-/// <reference types="node" />
-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 };
+/// <reference types="node" />
+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 +1 @@
-export {};
+export {};

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

@@ -1,7 +1,7 @@
-import React from 'react';
-declare const _default: {
-    title: string;
-};
-export default _default;
-export declare const MetronomeCanvasPlaygroundDemo: React.FC;
-export declare const MetronomeCanvasDemo: React.FC;
+import React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const MetronomeCanvasPlaygroundDemo: React.FC;
+export declare const MetronomeCanvasDemo: React.FC;