HM-37. Документирование классов RouteService, RoutePagesContainer. До… (#15)

src/services/EmitService.js

@@ -16,6 +16,11 @@ class EmitService {
      * Метод подписки на события компонента
      * @param {string} eventName - событие компонента, на которое будет реагировать обработчик
      * @param {Function} listener - обработчик события
+     * @example
+     * // Подписка на событие
+     * _.subscribe('click', () => {
+     *     ...
+     * });
      */
     subscribe = (eventName, listener) => {
         const listeners = this._events[eventName] || [];
@@ -29,6 +34,10 @@ class EmitService {
      * Метод генерирует событие
      * @param {string} eventName - событие, которое необходимо сгенерировать
      * @param  {unknown[]} args - аругемнты, который необходимо передать обработчикам события
+     * @example
+     * // Сгенерировать событие. Можно передать любое количество аругментов, все эти аргументы в таком же
+     * // порядке будут переданы подписчикам компонента
+     * _.next('click', arg1, arg2, ..., argN);
      */
     next = (eventName, ...args) => {
         const listeners = this._events[eventName];

src/services/RouteService.js

@@ -1,9 +1,28 @@
 import EmitService from './EmitService';
 import {parse, stringify} from 'querystring';
 
+/**
+ * @function RouterListener
+ * @param {string} url - путь роута
+ * @param {Object<string, string>} query - объект ключ-значение из url
+ */
+
+/**
+ * Константа для события изменения роута
+ * @private
+ */
 const ROUTE_CHANGE = 'routeChange';
 
+/**
+ * Класс для работы с роутингом. Позволяет переходить по роутам и генерит событие изменения роута.
+ */
 class RouteService extends EmitService {
+    /**
+     * @type {boolean} - проверяет чтобы инициализация была не больше одного раза
+     * @private
+     */
+    _isInit = false;
+
     constructor () {
         super();
 
@@ -11,6 +30,10 @@ class RouteService extends EmitService {
         this._events[ROUTE_CHANGE] = [];
     }
 
+    /**
+     * Метод получения данных url'а
+     * @private
+     */
     getUrlData = () => {
         return {
             url: location.pathname,
@@ -18,14 +41,37 @@ class RouteService extends EmitService {
         };
     }
 
+    /**
+     * Генерирует событие изменения роута
+     * @private
+     */
     generateNext = () => {
         this.next(ROUTE_CHANGE, this.getUrlData());
     }
 
+    /**
+     * Метод инициализации сервиса, чтобы сгенерить первое событие перехода для приложения
+     */
     init = () => {
-        this.generateNext();
+        if (!this._isInit) {
+            this.generateNext();
+            return;
+        }
+        throw new Error('RouteService можно инициализировать только 1 раз!');
     }
 
+    /**
+     * Метод перехода по маршрутам
+     * @param {string} url - принимает маршрут для перехода
+     * @param {query} query - объект с парами ключ-значение для url
+     * @example
+     * // Переход по заданному url
+     * _.goTo('/users', {
+     *     key: 'testApi',
+     *     author: 'Petrov',
+     * });
+     * // Это создаст строку в url - site.ru/users?key=testApi&author=Petrov
+     */
     goTo = (url, query) => {
         const stringQuery = stringify(query);
         const urlWithQuery = url + (stringQuery ? `?${stringQuery}` : '');
@@ -33,6 +79,15 @@ class RouteService extends EmitService {
         this.generateNext();
     }
 
+    /**
+     * С помощью этого метода подписываемся на событие изменения роута.
+     * @param {RouterListener} listener - слушатель для события изменения роута
+     * @example
+     * // Подписка на изменение url
+     * _.onChange(({url, query}) => {
+     *     ...
+     * });
+     */
     onChange = (listener) => {
         this.subscribe(ROUTE_CHANGE, listener);
     }