resetListenTimeout и autoResetTimeout

docs/events.md

@@ -18,10 +18,11 @@ builder.on("page_update", (page) => {
 
 ### Listen
 
-| Событие        | Передаваемые данные | Описание                |
-| -------------- | ------------------- | ----------------------- |
-| `listen_stop`  |                     | Остановка прослушивание |
-| `listen_start` |                     | Начало прослушивания    |
+| Событие                | Передаваемые данные | Описание                             |
+| ---------------------- | ------------------- | ------------------------------------ |
+| `listen_stop`          |                     | Остановка прослушивание              |
+| `listen_start`         |                     | Начало прослушивания                 |
+| `listen_reset_timeout` |                     | Сброс времени прослушивания страницы |
 
 ### Triggers
 

docs/listen.md

@@ -3,6 +3,9 @@
 <dt><a href="#setListenTime">setListenTime(time)</a> ⇒ <code>this</code>;</dt>
 <dd><p>Метод для установки времени прослушивания обновлений для переключения страниц</p></dd>
 
+<dt><a href="#resetListenTimeout">resetListenTimeout();</a></dt>
+<dd><p>Метод для сброса текущего таймера прослушивания</p></dd>
+
 <dt><a href="#setListenUsers">setListenUsers(users)</a> ⇒ <code>this</code>;</dt>
 <dd><p>Метод для установки прослушивания определенных пользователей</p></dd>
 
@@ -27,9 +30,24 @@
 **Пример**:
 
 ```js
+const builder = context.pageBuilder();
+
 builder.setListenTime(40000);
 ```
 
+<a name="setListenTime"></a>
+
+## setListenTime(time) ⇒ <code>this</code>;
+Метод для сброса текущего таймера прослушивания
+
+**Пример**:
+
+```js
+const builder = context.pageBuilder();
+
+builder.resetListenTimeout();
+```
+
 <a name="setListenUsers"></a>
 
 ## setListenUsers(users) ⇒ <code>this</code>;

docs/pages.md

@@ -9,6 +9,9 @@
 <dt><a href="#setPage">setPage(pageNumber)</a> ⇒ <code>Promise</code>;</dt>
 <dd><p>Метод для открытия определенной страницы</p></dd>
 
+<dt><a href="#autoResetTimeout">autoResetTimeout(status)</a> ⇒ <code>this</code>;</dt>
+<dd><p>Метод для установки автоматического сброса таймера при переключении между страницами</p></dd>
+
 <dt><a href="#setPageNumberFormat">setPageNumberFormat(format)</a> ⇒ <code>this</code>;</dt>
 <dd><p>Метод для установки формата нумерования страниц</p></dd>
 
@@ -94,6 +97,25 @@ builder.build()
     .setPage(2);
 ```
 
+<a name="autoResetTimeout"></a>
+
+## autoResetTimeout(status) ⇒ <code>this</code>;
+Метод для установки автоматического сброса таймера при переключении между страницами
+
+**Возвращает**: `this` - Текущий контекст билдера
+
+| Параметры | Тип       | По умолчанию  | Описание                                |
+| --------- | --------- | ------------- | --------------------------------------- |
+| status    | `boolean` | `true`        | Значение автоматического сброса таймера |
+
+**Пример**:
+
+```js
+const builder = context.pageBuilder();
+
+builder.autoResetTimeout();
+```
+
 <a name="setPageNumberFormat"></a>
 
 ## setPageNumberFormat(format) ⇒ <code>this</code>;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vk-io-pages",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Модуль vk-io для создания динамических страниц",
   "main": "./lib/PagesManager.js",
   "exports": {

src/PageBuilder.mjs → src/PagesBuilder.mjs

@@ -28,10 +28,14 @@ export class PagesBuilder extends EventEmitter {
         this.pages = [];
         this.currentPage = 1;
         this.infinityLoop = true;
+        this.resetTimeout = false;
         this.pageNumberFormat = "%c / %m";
+        this.sendMethod = "send_new";
+
         this.listenTime = 5 * 60 * 1000; // 5 минут
+        this._listenTimeout = null;
         this.listenUsers = [];
-        this.sendMethod = "send_new";
+
         this.triggers = null;
 
         this.sentContext = null;
@@ -74,11 +78,31 @@ export class PagesBuilder extends EventEmitter {
     async setPage(pageNumber) {
         this.currentPage = pageNumber;
 
+        if (this.resetTimeout) {
+            this.resetListenTimeout();
+        }
+
+        this._saveContext();
+
         const page = await this._getPage(pageNumber);
 
         this.emit("page_set", pageNumber);
 
-        return new ContextUtils(this)._editMessage(page);
+        return new ContextUtils(this)
+            ._editMessage(page);
+    }
+
+    /**
+     * @description Метод для установки автоматического сброса таймера при переключении между страницами
+     * @param {boolean} status=true - Значение автоматического сброса таймера
+     * @return this
+     */
+    autoResetTimeout(status = true) {
+        this.resetTimeout = status;
+
+        this._saveContext();
+
+        return this;
     }
 
     /**
@@ -114,6 +138,9 @@ export class PagesBuilder extends EventEmitter {
         return this;
     }
 
+    /**
+     * @private
+     */
     async _getPage(page = null) {
         page = page ?? this.currentPage;
 
@@ -150,9 +177,22 @@ export class PagesBuilder extends EventEmitter {
         return this;
     }
 
+    /**
+     * @description Метод для сброса текущего таймера прослушивания
+     */
+    resetListenTimeout() {
+        clearTimeout(this._listenTimeout);
+
+        this._listenTimeout = setTimeout(this.stopListen.bind(this), this.listenTime);
+
+        this._saveContext();
+
+        this.emit("listen_reset_timeout");
+    }
+
     /**
      * @description Метод для установки прослушивания определенных пользователей
-     * @param {[number]|number} users=[] - Пользватели для прослушивания
+     * @param {[number]|number} users=[] - Пользователи для прослушивания
      * @return this
      */
     setListenUsers(users = []) {
@@ -180,16 +220,18 @@ export class PagesBuilder extends EventEmitter {
      * @description Метод для досрочной остановки прослушивания новых сообщений
      */
     async stopListen() {
+        clearTimeout(this._listenTimeout);
         pagesStorage.delete(this.id);
 
-        const page = await this._getPage(this.currentPage);
-
         this.emit("listen_stop", this.currentPage);
 
-        new ContextUtils(this)._editMessage({
-            ...page,
-            keyboard: JSON.stringify({})
-        }, "stop");
+        const page = await this._getPage(this.currentPage);
+
+        new ContextUtils(this)
+            ._editMessage({
+                ...page,
+                keyboard: JSON.stringify({})
+            }, "stop");
     }
 
     /**
@@ -288,6 +330,9 @@ export class PagesBuilder extends EventEmitter {
         return this;
     }
 
+    /**
+     * @private
+     */
     _executeTrigger(trigger) {
         trigger = this.triggers.get(trigger);
 
@@ -321,18 +366,24 @@ export class PagesBuilder extends EventEmitter {
 
                     this.emit("listen_start");
 
-                    setTimeout(this.stopListen.bind(this), this.listenTime);
+                    this.resetListenTimeout();
 
                     resolve(this);
                 })
                 .catch(reject);
         });
     }
 
+    /**
+     * @private
+     */
     _saveContext() {
         pagesStorage.set(this.id, this);
     }
 
+    /**
+     * @private
+     */
     _executeAction(action) {
         this.emit("page_action_execute", action);
 
@@ -391,6 +442,9 @@ export class PagesBuilder extends EventEmitter {
         }
     }
 
+    /**
+     * @private
+     */
     _messageMiddleware(context) {
         this._context = context;
 
@@ -428,7 +482,5 @@ export class PagesBuilder extends EventEmitter {
                 this._executeTrigger(trigger);
             }
         }
-
-        this._saveContext();
     }
 }

src/PagesManager.mjs

@@ -1,6 +1,6 @@
 import VKIO from "vk-io";
 
-import { PagesBuilder, pagesStorage } from "./PageBuilder";
+import { PagesBuilder, pagesStorage } from "./PagesBuilder";
 
 const { API } = VKIO;
 

test/externalTest.mjs

@@ -1,4 +1,4 @@
-import { PagesBuilder, pagesStorage } from "../src/PageBuilder.mjs";
+import { PagesBuilder, pagesStorage } from "../src/PagesBuilder.mjs";
 import { test } from "./tests.mjs";
 
 test(PagesBuilder, pagesStorage, "ESM");