add jsdoc

lib/dispatcher/fixed-queue.js

@@ -54,27 +54,56 @@ const kMask = kSize - 1
 // `top + 1 === bottom` it's full. This wastes a single space of storage
 // but allows much quicker checks.
 
+/**
+ * @type {FixedCircularBuffer}
+ * @template T
+ */
 class FixedCircularBuffer {
   constructor () {
+    /**
+     * @type {number}
+     */
     this.bottom = 0
+    /**
+     * @type {number}
+     */
     this.top = 0
+    /**
+     * @type {Array<T|undefined>}
+     */
     this.list = new Array(kSize).fill(undefined)
+    /**
+     * @type {T|null}
+     */
     this.next = null
   }
 
+  /**
+   * @returns {boolean}
+   */
   isEmpty () {
     return this.top === this.bottom
   }
 
+  /**
+   * @returns {boolean}
+   */
   isFull () {
     return ((this.top + 1) & kMask) === this.bottom
   }
 
+  /**
+   * @param {T} data
+   * @returns {void}
+   */
   push (data) {
     this.list[this.top] = data
     this.top = (this.top + 1) & kMask
   }
 
+  /**
+   * @returns {T|null}
+   */
   shift () {
     const nextItem = this.list[this.bottom]
     if (nextItem === undefined) { return null }
@@ -84,15 +113,27 @@ class FixedCircularBuffer {
   }
 }
 
+/**
+ * @template T
+ */
 module.exports = class FixedQueue {
   constructor () {
+    /**
+     * @type {FixedCircularBuffer<T>}
+     */
     this.head = this.tail = new FixedCircularBuffer()
   }
 
+  /**
+   * @returns {boolean}
+   */
   isEmpty () {
     return this.head.isEmpty()
   }
 
+  /**
+   * @param {T} data
+   */
   push (data) {
     if (this.head.isFull()) {
       // Head is full: Creates a new queue, sets the old queue's `.next` to it,
@@ -102,6 +143,9 @@ module.exports = class FixedQueue {
     this.head.push(data)
   }
 
+  /**
+   * @returns {T|null}
+   */
   shift () {
     const tail = this.tail
     const next = tail.shift()