add interface

lint
version bump

Author: kleinron

benchmark/package.json

@@ -12,8 +12,8 @@
     "@datastructures-js/queue": "4.2.3",
     "dsa.js": "2.7.6",
     "efficient-data-structures": "0.1.310",
-    "markdown-table": "3.0.3",
-    "mnemonist": "0.39.8",
-    "shelljs": "^0.8.5"
+    "markdown-table": "^3.0.4",
+    "mnemonist": "^0.40.3",
+    "shelljs": "^0.10.0"
   }
 }

benchmark/report-generator.js

@@ -17,7 +17,7 @@ reportConfig.scenarios.forEach(scenario => {
     for (let i = 0; i < reportConfig.iterationsPerClass; i++) {
       commandObjects.push({
         scenarioName: scenario.name,
-        scenario: scenario,
+        scenario,
         className,
         command: `node ${path.join(__dirname, 'ramusage.js')} ${className} ${scenario.operations.join(' ')}`
       });
@@ -44,7 +44,7 @@ for (let i = 0; i < commandObjects.length; i++) {
   const resp = shell.exec(command, { silent: true });
   resultObjects.push({
     className: commandObject.className,
-    scenarioName: scenarioName,
+    scenarioName,
     scenario: commandObject.scenario,
     result: JSON.parse(resp.stdout)
   });
@@ -83,7 +83,7 @@ const stats = resultsByScenario.entries().map(([scenarioName, resultsByClassName
       const avgOpsPerSec = Math.trunc(avg(v.map(x => x.result.opsPerSec)));
       return {
         className: k,
-        avgOpsPerSec: avgOpsPerSec,
+        avgOpsPerSec,
         avgHeapUsed: Math.trunc(avg(v.map(x => x.result.heapUsed))),
         avgHeapUsedLog10: Math.trunc(100 * Math.log10(avg(v.map(x => x.result.heapUsed)))) / 100
       };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lite-fifo",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "main": "src/index.js",
   "types": "types/index.d.ts",
@@ -13,10 +13,10 @@
   "homepage": "https://github.com/kleinron/lite-fifo.git#readme",
   "description": "Lightweight, optimized, and efficient implementations for FIFO (queue) data structure",
   "devDependencies": {
-    "mocha": "10.1.0",
+    "mocha": "^11.7.1",
     "seedrandom": "^3.0.5",
-    "semistandard": "^16.0.1",
-    "typescript": "^4.6.4"
+    "semistandard": "^17.0.0",
+    "typescript": "^5.9.2"
   },
   "scripts": {
     "lint": "semistandard",

src/index.js

@@ -5,9 +5,9 @@ const { DynamicCyclicQueue } = require('./DynamicCyclicQueue');
 const { LinkedQueue } = require('./LinkedQueue');
 
 module.exports = {
-  ChunkedQueue: ChunkedQueue,
-  DynamicArrayQueue: DynamicArrayQueue,
-  DynamicCyclicQueue: DynamicCyclicQueue,
-  LinkedQueue: LinkedQueue,
-  CyclicQueue: CyclicQueue
+  ChunkedQueue,
+  DynamicArrayQueue,
+  DynamicCyclicQueue,
+  LinkedQueue,
+  CyclicQueue
 };

src/interfaces.js

@@ -0,0 +1,26 @@
+/**
+ * @fileoverview Interface definitions for queue implementations
+ */
+
+/**
+ * Common interface for all queue implementations
+ * @typedef {Object} QueueInterface
+ * @template T The type of items stored in the queue
+ * @property {function(T): void} enqueue - Add an item to the queue
+ * @property {function(): T} dequeue - Remove and return the oldest item from the queue
+ * @property {function(): number} size - Return the current size of the queue
+ * @property {function(): void} clear - Clear all items from the queue
+ * @property {function(): T} peek - Return the oldest item without removing it
+ * @property {function(): boolean} isEmpty - Check if the queue is empty
+ * @property {function(): T[]} toArray - Convert queue to array
+ * @property {function(): string} toJSON - Serialize queue to JSON
+ * @property {function(T[], number=): void} copyTo - Copy queue items to an array
+ */
+
+/**
+ * Interface for bounded queues that have a maximum capacity
+ * @typedef {QueueInterface<T> & {capacity: function(): number}} BoundedQueueInterface
+ * @template T The type of items stored in the queue
+ */
+
+module.exports = {};

types/ChunkedQueue.d.ts

@@ -8,7 +8,7 @@ export class ChunkedQueue<T> {
     /**
      * @param {number} [chunkSize=1024] Size of each internal chunk
      */
-    constructor(chunkSize?: number | undefined);
+    constructor(chunkSize?: number);
     /** @private */
     private _queue;
     /** @private */
@@ -87,7 +87,7 @@ export class ChunkedQueue<T> {
      * @param {number} [startIndex=0] Starting index in the array
      * @returns {void}
      */
-    copyTo(arr: T[], startIndex?: number | undefined): void;
+    copyTo(arr: T[], startIndex?: number): void;
     /**
      * Create an array with the same size as the queue, populate it with the items in the queue, keeping the iteration order, and return it.
      * @returns {T[]} Array containing all queue items

types/ChunkedQueue.d.ts.map

@@ -8,7 +8,7 @@ export class CyclicQueue<T> {
     /**
      * @param {number} [capacity=16] Maximum number of items the queue can hold
      */
-    constructor(capacity?: number | undefined);
+    constructor(capacity?: number);
     /** @private */
     private _capacity;
     /**
@@ -105,7 +105,7 @@ export class CyclicQueue<T> {
      * @param {number} [startIndex=0] Starting index in the array
      * @returns {void}
      */
-    copyTo(arr: T[], startIndex?: number | undefined): void;
+    copyTo(arr: T[], startIndex?: number): void;
     /**
      * Create an array with the same size as the queue, populate it with the items in the queue, keeping the iteration order, and return it.
      * @returns {T[]} Array containing all queue items

types/CyclicQueue.d.ts

@@ -82,7 +82,7 @@ export class DynamicArrayQueue<T> {
      * @param {number} [startIndex=0] Starting index in the array
      * @returns {void}
      */
-    copyTo(arr: T[], startIndex?: number | undefined): void;
+    copyTo(arr: T[], startIndex?: number): void;
     /**
      * Create an array with the same size as the queue, populate it with the items in the queue, keeping the iteration order, and return it.
      * @returns {T[]} Array containing all queue items