Merge pull request #188 from MasatoMakino/change-#86

chage : rename to "restart"
MasatoMakino · May 27, 2024 · 880059b · 880059b
2 parents f024f17 + a8a33b8
commit 880059b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 13 deletions.
diff --git a/__test__/sleep.spec.ts b/__test__/sleep.spec.ts
@@ -160,7 +160,7 @@ describe("threejs-drag-watcher", () => {
     clearMockFunctions();
   });
 
-  test("reset timer", () => {
+  test("restart timer", () => {
     sleepWatcher.start();
 
     interval(timeout_ms * 0.6);
@@ -170,7 +170,7 @@ describe("threejs-drag-watcher", () => {
 
     dispatchMouseEvent("pointerdown", { offsetX: 0, offsetY: 0 });
     interval(timeout_ms * 0.6);
-    sleepWatcher.reset();
+    sleepWatcher.restart();
     interval(timeout_ms * 0.6);
     expect(mockSleep).not.toBeCalled();
     clearMockFunctions();

diff --git a/src/SleepWatcher.ts b/src/SleepWatcher.ts
@@ -17,20 +17,19 @@ export class SleepWatcher extends EventEmitter<SleepEventMap> {
 
   /**
    * 無操作タイマーをリセットし、再度カウントを開始する。
+   * @deprecated This method will be removed in v0.13.0. Please use restart() instead.
    */
   public reset(): void {
-    this.stopTimer();
-    this.wakeup();
-
-    this.sleepTimerID = window.setTimeout(this.sleep, this.timeOut_ms);
+    this.restart();
   }
 
   /**
    * 無操作タイマーをリセットし、再度カウントを開始する。
-   * zoomイベントハンドラー
    */
-  private resetTimer = () => {
-    this.reset();
+  public restart = (): void => {
+    this.stopTimer();
+    this.wakeup();
+    this.sleepTimerID = window.setTimeout(this.sleep, this.timeOut_ms);
   };
 
   private stopTimer(): void {
@@ -57,12 +56,12 @@ export class SleepWatcher extends EventEmitter<SleepEventMap> {
   public start(): void {
     this.stopMouseEventListeners();
     this.startMouseEventListeners();
-    this.resetTimer();
+    this.restart();
   }
 
   protected startMouseEventListeners(): void {
     const watcher = this.dragWatcher;
-    watcher.on("zoom", this.resetTimer);
+    watcher.on("zoom", this.restart);
     watcher.on("drag_start", this.pauseTimer);
   }
 
@@ -76,7 +75,7 @@ export class SleepWatcher extends EventEmitter<SleepEventMap> {
   };
 
   private resumeTimer = () => {
-    this.resetTimer();
+    this.restart();
 
     const watcher = this.dragWatcher;
     watcher.on("drag_start", this.pauseTimer);
@@ -94,7 +93,7 @@ export class SleepWatcher extends EventEmitter<SleepEventMap> {
 
   protected stopMouseEventListeners(): void {
     const watcher = this.dragWatcher;
-    watcher.off("zoom", this.resetTimer);
+    watcher.off("zoom", this.restart);
     watcher.off("drag_start", this.pauseTimer);
     watcher.off("drag_end", this.resumeTimer);
   }