Class Timeout

python/pythonmonkey/builtin_modules/timers.js:24–96

* Implement Node.js-style `timeoutId` class returned from setTimeout() and setInterval() * @see https://nodejs.org/api/timers.html#class-timeout

 * @see https://nodejs.org/api/timers.html#class-timeout
 */
class Timeout
{
  /** @type {number} an integer */
  #numericId;

  /**
   * @param {number} numericId 
   */
  constructor(numericId)
  {
    this.#numericId = numericId;
  }

  /**
   * If `true`, the `Timeout` object will keep the event-loop active.
   * @returns {boolean}
   */
  hasRef()
  {
    return timerHasRef(this.#numericId);
  }

  /**
   * When called, requests that the event-loop **not exit** so long as the `Timeout` is active.
   *   
   * By default, all `Timeout` objects are "ref'ed", making it normally unnecessary to call `timeout.ref()` unless `timeout.unref()` had been called previously.
   */
  ref()
  {
    timerAddRef(this.#numericId);
    return this; // allow chaining
  }

  /**
   * When called, the active `Timeout` object will not require the event-loop to remain active.  
   * If there is no other activity keeping the event-loop running, the process may exit before the `Timeout` object's callback is invoked.
   */
  unref()
  {
    timerRemoveRef(this.#numericId);
    return this; // allow chaining
  }

  /**
   * Sets the timer's start time to the current time, 
   * and reschedules the timer to call its callback at the previously specified duration adjusted to the current time.
   * 
   * Using this on a timer that has already called its callback will reactivate the timer.
   */
  refresh()
  {
    throw new DOMException('Timeout.refresh() method is not supported by PythonMonkey.', 'NotSupportedError');
    // TODO: Do we really need to closely resemble the Node.js API?
    // This one is not easy to implement since we need to memorize the callback function and delay parameters in every `setTimeout`/`setInterval` call.
  }

  /**
   * Cancels the timeout.