@pryv/monitor/src/UpdateMethod/UpdateMethod.js

Extends `pryv` with event-driven notifications for changes on a Pryv.io account

/**
 * @license
 * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
 */
const Changes = require('../lib/Changes');
/**
 * Interface for UpdateMonitor
 * @memberof pryv.Monitor
 * @constructor {Monitor~UpdateMethod} updateMethod.setMonitor - set only once
 */
class UpdateMethod {
  /**
   * Assign a Monitor to this updater.
   * Usually called by the monitor itself on monitor.addUpdateMethod()
   * @param {Monitor} monitor
   */
  setMonitor (monitor) {
    if (this.monitor) {
      throw new Error('An update Method can be assigned to one monitor only');
    }
    this.monitor = monitor;
    monitor.on(Changes.READY, this.ready.bind(this));
    monitor.on(Changes.STOP, this.stop.bind(this));
    if (monitor.started) {
      this.ready();
    }
  }

  /**
   * Should be overwritten by subclases
   * Called with no params, when all update tasks are done.
   * Also used at "start" call
   */
  async ready () { }

  /**
   * Should be overwritten by subclases
   * Called with no params, when monitor is stoped: updater should be stoped too.
   */
  async stop () { }
}

module.exports = UpdateMethod;