@odx/angular 6.1.0 → 6.2.0

package/utils/lib/helpers/queue.d.ts

@@ -18,50 +18,59 @@ export declare class Queue<T> {
     private lastItem;
     /**
      * An observable that emits when an item is added to the queue.
+     *
      * @type {Observable<T>}
      */
     readonly onAdd$: Observable<T>;
     /**
      * An observable that emits when an item in the queue is updated.
+     *
      * @type {Observable<T>}
      */
     readonly onUpdate$: Observable<T>;
     /**
      * An observable that emits when an item is removed from the queue.
+     *
      * @type {Observable<T>}
      */
     readonly onRemove$: Observable<T>;
     /**
      * An observable representing the current state of the queue as an array of items.
+     *
      * @type {Observable<QueueItem<T>[]>}
      */
     readonly value$: Observable<QueueItem<T>[]>;
     /**
      * An observable that emits the current size of the queue.
+     *
      * @type {Observable<number>}
      */
     readonly size$: Observable<number>;
     /**
      * Gets the size of the queue.
-     * @returns The number of elements in the queue.
+     *
+     * @returns {number} - The number of elements in the queue.
      */
     get size(): number;
     /**
      * Checks if the specified item is the first item in the queue.
+     *
      * @param {QueueItem<T>} item - The item to check.
      * @returns {boolean} - Returns `true` if the item is the first item in the queue, `false` otherwise.
      */
     isFirst({ id }: QueueItem<T>): boolean;
     /**
      * Checks if the specified item is the last item in the queue.
+     *
      * @param {QueueItem<T>} item - The item to check.
      * @returns {boolean} - Returns true if the item is the last item, otherwise returns false.
      */
     isLast({ id }: QueueItem<T>): boolean;
     /**
      * Retrieves a queue item from the queue based on the provided item or item ID.
-     * @param itemOrId - The queue item or item ID to retrieve.
-     * @returns The queue item if found, or `null` if not found.
+     *
+     * @param {QueueItem<T> | QueueItemId} itemOrId - The queue item or item ID to retrieve.
+     * @returns {QueueItem<T> | null} - The queue item if found, or `null` if not found.
      */
     get(itemOrId: QueueItem<T> | QueueItemId): QueueItem<T> | null;
     /**
@@ -75,36 +84,37 @@ export declare class Queue<T> {
     /**
      * Adds multiple items to the queue.
      *
-     * @param items - An array of items to be added to the queue.
-     * @param emitEvent - (Optional) A boolean indicating whether to emit an event after adding the items. Default is true.
-     * @returns An array of added items.
+     * @param {Array<QueueItem<T>>} items - An array of items to be added to the queue.
+     * @param {boolean} emitEvent - (Optional) A boolean indicating whether to emit an event after adding the items. Default is true.
+     * @returns {Array<QueueItem<T>>} An array of added items.
      */
     addMany(items: Array<QueueItem<T>>, emitEvent?: boolean): Array<QueueItem<T>>;
     /**
      * Removes an item from the queue.
      *
-     * @param itemOrId - The item or ID of the item to be removed.
-     * @param emitEvent - Whether to emit an event after removing the item. Default is `true`.
+     * @param {Array<QueueItem<T> | QueueItemId>} itemOrId - The item or ID of the item to be removed.
+     * @param {boolean} emitEvent - Whether to emit an event after removing the item. Default is `true`.
      * @returns The removed item, or `null` if the item was not found.
      */
     remove(itemOrId: QueueItem<T> | QueueItemId, emitEvent?: boolean): QueueItem<T> | null;
     /**
      * Removes multiple items from the queue based on the provided item or item IDs.
-     * @param itemOrIds - An array of QueueItem or QueueItemId objects representing the items to be removed.
-     * @param emitEvent - A boolean indicating whether to emit an event after removing the items. Default is true.
-     * @returns An array of removed QueueItem objects or null values.
+     *
+     * @param {Array<QueueItem<T> | QueueItemId>} itemOrIds - An array of QueueItem or QueueItemId objects representing the items to be removed.
+     * @param {boolean} emitEvent - A boolean indicating whether to emit an event after removing the items. Default is true.
+     * @returns {Array<QueueItem<T> | null>} An array of removed QueueItem objects or null values.
      */
     removeMany(itemOrIds: Array<QueueItem<T> | QueueItemId>, emitEvent?: boolean): Array<QueueItem<T> | null>;
     /**
      * Clears the queue by removing all items.
      *
-     * @param emitEvent - Whether to emit an event after clearing the queue. Default is true.
+     * @param {boolean} emitEvent - Whether to emit an event after clearing the queue. Default is true.
      */
     clear(emitEvent?: boolean): void;
     /**
      * Returns an array representation of the queue.
      *
-     * @returns An array containing all the items in the queue.
+     * @returns {QueueItem<T>[]} An array containing all the items in the queue.
      */
     toArray(): QueueItem<T>[];
     private notify;