collect-your-stuff 1.2.6 → 1.2.8

package/dist/collections/queue/Queue.js

@@ -1,136 +1,130 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.Queue = void 0
-var _Queueable = require('./Queueable')
-var _LinkedList = require('../linked-list/LinkedList')
-/**
- * @file queue
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-
-/**
- * Maintain a series of queued items.
- */
-class Queue {
-  /**
-   * Instantiate the queue with the given queue list.
-   * @param {Iterable|LinkedList} queuedList Give the list of queueables to start in this queue.
-   * @param {IsArrayable} listClass
-   * @param {Queueable} queueableClass
-   */
-  constructor () {
-    let queuedList = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
-    const listClass = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _LinkedList.LinkedList
-    const queueableClass = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : _Queueable.Queueable
-    this.listClass = listClass
-    this.queueableClass = queueableClass
-    if (queuedList === null) {
-      queuedList = new listClass(queueableClass)
-    }
-    this.queuedList = queuedList
-  }
-
-  /**
-   * Take a queued task from the front of the queue and run it if ready.
-   * @return {completeResponse|*}
-   */
-  dequeue () {
-    const next = this.remove()
-    if (!next) {
-      return {
-        success: 'No more queueable tasks in the queue',
-        error: false,
-        context: this.queuedList
-      }
-    }
-    if (next.complete) {
-      // Previously ran queued, run next
-      return this.dequeue()
-    }
-    if (next.running) {
-      return {
-        success: false,
-        error: 'The queue has been blocked by an unfinished task.',
-        context: next
-      }
-    }
-    if (!this.empty()) {
-      // Place back in queue to be checked once again next time, only if the queue will not be empty
-      this.enqueue(next)
-    }
-    if (next.isReady) {
-      return next.run.call(next)
-    }
-    // We could go check the next in queue here but if we end up in a state where nothing is ready it would infinite loop
-    // Also, we want the loop handled externally
-    return {
-      success: false,
-      error: 'Unable to find ready task.',
-      context: next
-    }
-  }
-
-  /**
-   * Return true if the queue is empty (there are no tasks in the queue list)
-   * @return {boolean}
-   */
-  empty () {
-    return this.size() <= 0
-  }
-
-  /**
-   * Add a queued task to the end of the queue
-   * @param {Queueable} queueable Add a new queueable to the end of the queue
-   */
-  enqueue (queueable) {
-    this.queuedList.append(queueable)
-  }
-
-  /**
-   * Take a look at the next queued task
-   * @return {Queueable}
-   */
-  peek () {
-    return this.queuedList.first
-  }
-
-  /**
-   * Remove the next queued item and return it.
-   * @return {Queueable|null}
-   */
-  remove () {
-    if (this.empty()) {
-      return null
-    }
-    return this.queuedList.remove(this.queuedList.first)
-  }
-
-  /**
-   * Get the length of the current queue.
-   * @return {number}
-   */
-  size () {
-    return this.queuedList.length
-  }
-}
-/**
- * Convert an array to a Queue.
- * @param {Array} values An array of values which will be converted to queueables in this queue
- * @param {Queueable} queueableClass The class to use for each queueable
- * @param {Queue|Iterable} listClass The class to use to manage the queueables
- * @returns {Queue}
- */
-exports.Queue = Queue
-Queue.fromArray = function () {
-  const values = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
-  const queueableClass = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _Queueable.Queueable
-  const listClass = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : _LinkedList.LinkedList
-  const list = new listClass(queueableClass)
-  list.initialize(queueableClass.fromArray(values, queueableClass).head)
-  return new Queue(list, listClass, queueableClass)
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.Queue = void 0
+var _Queueable = require('./Queueable')
+var _LinkedList = require('../linked-list/LinkedList')
+/**
+ * @file queue
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+
+/**
+ * Maintain a series of queued items.
+ */
+class Queue {
+  /**
+   * Instantiate the queue with the given queue list.
+   * @param {Iterable|LinkedList} queuedList Give the list of queueables to start in this queue.
+   * @param {IsArrayable} listClass
+   * @param {Queueable} queueableClass
+   */
+  constructor (queuedList = null, listClass = _LinkedList.LinkedList, queueableClass = _Queueable.Queueable) {
+    this.listClass = listClass
+    this.queueableClass = queueableClass
+    if (queuedList === null) {
+      queuedList = new listClass(queueableClass)
+    }
+    this.queuedList = queuedList
+  }
+
+  /**
+   * Take a queued task from the front of the queue and run it if ready.
+   * @return {completeResponse|*}
+   */
+  dequeue () {
+    const next = this.remove()
+    if (!next) {
+      return {
+        success: 'No more queueable tasks in the queue',
+        error: false,
+        context: this.queuedList
+      }
+    }
+    if (next.complete) {
+      // Previously ran queued, run next
+      return this.dequeue()
+    }
+    if (next.running) {
+      return {
+        success: false,
+        error: 'The queue has been blocked by an unfinished task.',
+        context: next
+      }
+    }
+    if (!this.empty()) {
+      // Place back in queue to be checked once again next time, only if the queue will not be empty
+      this.enqueue(next)
+    }
+    if (next.isReady) {
+      return next.run.call(next)
+    }
+    // We could go check the next in queue here but if we end up in a state where nothing is ready it would infinite loop
+    // Also, we want the loop handled externally
+    return {
+      success: false,
+      error: 'Unable to find ready task.',
+      context: next
+    }
+  }
+
+  /**
+   * Return true if the queue is empty (there are no tasks in the queue list)
+   * @return {boolean}
+   */
+  empty () {
+    return this.size() <= 0
+  }
+
+  /**
+   * Add a queued task to the end of the queue
+   * @param {Queueable} queueable Add a new queueable to the end of the queue
+   */
+  enqueue (queueable) {
+    this.queuedList.append(queueable)
+  }
+
+  /**
+   * Take a look at the next queued task
+   * @return {Queueable}
+   */
+  peek () {
+    return this.queuedList.first
+  }
+
+  /**
+   * Remove the next queued item and return it.
+   * @return {Queueable|null}
+   */
+  remove () {
+    if (this.empty()) {
+      return null
+    }
+    return this.queuedList.remove(this.queuedList.first)
+  }
+
+  /**
+   * Get the length of the current queue.
+   * @return {number}
+   */
+  size () {
+    return this.queuedList.length
+  }
+}
+/**
+ * Convert an array to a Queue.
+ * @param {Array} values An array of values which will be converted to queueables in this queue
+ * @param {Queueable} queueableClass The class to use for each queueable
+ * @param {Queue|Iterable} listClass The class to use to manage the queueables
+ * @returns {Queue}
+ */
+exports.Queue = Queue
+Queue.fromArray = (values = [], queueableClass = _Queueable.Queueable, listClass = _LinkedList.LinkedList) => {
+  const list = new listClass(queueableClass)
+  list.initialize(queueableClass.fromArray(values, queueableClass).head)
+  return new Queue(list, listClass, queueableClass)
+}

package/dist/collections/queue/Queue.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Queue=void 0;var _Queueable=require("./Queueable"),_LinkedList=require("../linked-list/LinkedList");class Queue{constructor(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null,u=arguments.length>1&&void 0!==arguments[1]?arguments[1]:_LinkedList.LinkedList,t=arguments.length>2&&void 0!==arguments[2]?arguments[2]:_Queueable.Queueable;this.listClass=u,this.queueableClass=t,null===e&&(e=new u(t)),this.queuedList=e}dequeue(){const e=this.remove();return e?e.complete?this.dequeue():e.running?{success:!1,error:"The queue has been blocked by an unfinished task.",context:e}:(this.empty()||this.enqueue(e),e.isReady?e.run.call(e):{success:!1,error:"Unable to find ready task.",context:e}):{success:"No more queueable tasks in the queue",error:!1,context:this.queuedList}}empty(){return this.size()<=0}enqueue(e){this.queuedList.append(e)}peek(){return this.queuedList.first}remove(){return this.empty()?null:this.queuedList.remove(this.queuedList.first)}size(){return this.queuedList.length}}exports.Queue=Queue,Queue.fromArray=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],u=arguments.length>1&&void 0!==arguments[1]?arguments[1]:_Queueable.Queueable,t=arguments.length>2&&void 0!==arguments[2]?arguments[2]:_LinkedList.LinkedList;const s=new t(u);return s.initialize(u.fromArray(e,u).head),new Queue(s,t,u)};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Queue=void 0;var _Queueable=require("./Queueable"),_LinkedList=require("../linked-list/LinkedList");class Queue{constructor(e=null,u=_LinkedList.LinkedList,t=_Queueable.Queueable){this.listClass=u,this.queueableClass=t,null===e&&(e=new u(t)),this.queuedList=e}dequeue(){const e=this.remove();return e?e.complete?this.dequeue():e.running?{success:!1,error:"The queue has been blocked by an unfinished task.",context:e}:(this.empty()||this.enqueue(e),e.isReady?e.run.call(e):{success:!1,error:"Unable to find ready task.",context:e}):{success:"No more queueable tasks in the queue",error:!1,context:this.queuedList}}empty(){return this.size()<=0}enqueue(e){this.queuedList.append(e)}peek(){return this.queuedList.first}remove(){return this.empty()?null:this.queuedList.remove(this.queuedList.first)}size(){return this.queuedList.length}}exports.Queue=Queue,Queue.fromArray=(e=[],u=_Queueable.Queueable,t=_LinkedList.LinkedList)=>{const s=new t(u);return s.initialize(u.fromArray(e,u).head),new Queue(s,t,u)};

package/dist/collections/queue/Queueable.d.ts

@@ -1,77 +1,77 @@
-/**
- * @file queueable item.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { completeResponse, IsRunnable } from '../../recipes/Runnable';
-import { IsLinker } from '../../recipes/IsLinker';
-/**
- * Queueable represents a runnable entry in a queue.
- * @extends Linker
- */
-export declare class Queueable implements IsLinker, IsRunnable {
-    readonly classType: typeof Queueable;
-    data: any;
-    next: Queueable | null;
-    complete: boolean;
-    ready: Function | boolean;
-    running: boolean;
-    /**
-     * Create a queueable item that can be used in a queue.
-     * @param {Object} [queueableData={}]
-     * @param {*} [queueableData.task=null] The data to be stored in this queueable
-     * @param {Queueable|null} [queueableData.next=null] The reference to the next queueable if any
-     * @param {boolean|Function} [queueableData.ready=false] Indicate if the queueable is ready to run
-     */
-    constructor({ task, next, ready }?: {
-        task?: any;
-        next?: Queueable | null;
-        ready?: boolean;
-    });
-    /**
-     * Check ready state.
-     * @return {boolean}
-     */
-    get isReady(): boolean;
-    /**
-     * Retrieve the data which should be formed as a task.
-     * @return {*}
-     */
-    get task(): any;
-    /**
-     * Set this queueable as completed.
-     * @param {Object} completeResponse
-     * @param {*} [completeResponse.success=true] Indicate when the task failed (use false) or give a success message
-     * @param {*} [completeResponse.error=false] Indicate a task was error-free (use false) or give an error message
-     * @param {*} [completeResponse.context=null] Provide additional data in the response
-     * @return {completeResponse}
-     */
-    markCompleted({ success, error, context }?: {
-        success?: any;
-        error?: any;
-        context?: any;
-    }): completeResponse;
-    /**
-     * Intend to run the queued task when it is ready. If ready, mark this task as running and run the task.
-     * @return {completeResponse}
-     */
-    run(): completeResponse;
-    /**
-     * Make a new Queueable from the data given if it is not already a valid Queueable.
-     * @param {Queueable|*} queueable Return a valid Queueable instance from given data, or even an already valid one.
-     * @param {IsLinker} [classType=Queueable] Provide the type of IsLinker to use.
-     * @return {Queueable}
-     */
-    static make: (queueable: Queueable | any, classType?: any) => IsLinker;
-    /**
-     * Convert an array into Queueable instances, return the head and tail Queueables.
-     * @param {Array} values Provide an array of data that will be converted to a chain of queueable linkers.
-     * @param {IsLinker} [classType=Queueable] Provide the type of IsLinker to use.
-     * @returns {{head: Queueable, tail: Queueable}}
-     */
-    static fromArray: (values: Array<any>, classType?: any) => {
-        head: IsLinker;
-        tail: IsLinker;
-    };
-}
+/**
+ * @file queueable item.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+import { completeResponse, IsRunnable } from '../../recipes/Runnable';
+import { IsLinker } from '../../recipes/IsLinker';
+/**
+ * Queueable represents a runnable entry in a queue.
+ * @extends Linker
+ */
+export declare class Queueable implements IsLinker, IsRunnable {
+    readonly classType: typeof Queueable;
+    data: any;
+    next: Queueable | null;
+    complete: boolean;
+    ready: Function | boolean;
+    running: boolean;
+    /**
+     * Create a queueable item that can be used in a queue.
+     * @param {Object} [queueableData={}]
+     * @param {*} [queueableData.task=null] The data to be stored in this queueable
+     * @param {Queueable|null} [queueableData.next=null] The reference to the next queueable if any
+     * @param {boolean|Function} [queueableData.ready=false] Indicate if the queueable is ready to run
+     */
+    constructor({ task, next, ready }?: {
+        task?: any;
+        next?: Queueable | null;
+        ready?: boolean;
+    });
+    /**
+     * Check ready state.
+     * @return {boolean}
+     */
+    get isReady(): boolean;
+    /**
+     * Retrieve the data which should be formed as a task.
+     * @return {*}
+     */
+    get task(): any;
+    /**
+     * Set this queueable as completed.
+     * @param {Object} completeResponse
+     * @param {*} [completeResponse.success=true] Indicate when the task failed (use false) or give a success message
+     * @param {*} [completeResponse.error=false] Indicate a task was error-free (use false) or give an error message
+     * @param {*} [completeResponse.context=null] Provide additional data in the response
+     * @return {completeResponse}
+     */
+    markCompleted({ success, error, context }?: {
+        success?: any;
+        error?: any;
+        context?: any;
+    }): completeResponse;
+    /**
+     * Intend to run the queued task when it is ready. If ready, mark this task as running and run the task.
+     * @return {completeResponse}
+     */
+    run(): completeResponse;
+    /**
+     * Make a new Queueable from the data given if it is not already a valid Queueable.
+     * @param {Queueable|*} queueable Return a valid Queueable instance from given data, or even an already valid one.
+     * @param {IsLinker} [classType=Queueable] Provide the type of IsLinker to use.
+     * @return {Queueable}
+     */
+    static make: (queueable: Queueable | any, classType?: any) => IsLinker;
+    /**
+     * Convert an array into Queueable instances, return the head and tail Queueables.
+     * @param {Array} values Provide an array of data that will be converted to a chain of queueable linkers.
+     * @param {IsLinker} [classType=Queueable] Provide the type of IsLinker to use.
+     * @returns {{head: Queueable, tail: Queueable}}
+     */
+    static fromArray: (values: Array<any>, classType?: any) => {
+        head: IsLinker;
+        tail: IsLinker;
+    };
+}