Merge pull request #23 from datastructures-js/fix_readme

update

Author: eyas-ranjous

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [4.1.4] - 2022-05-15
+### Fixed
+- README
+
 ## [4.1.3] - 2021-06-20
 ### Fixed
 - index.d.ts

README.md

@@ -1,6 +1,5 @@
 # @datastructures-js/queue
 
-[![build:?](https://travis-ci.org/datastructures-js/queue.svg?branch=master)](https://travis-ci.org/datastructures-js/queue) 
 [![npm](https://img.shields.io/npm/v/@datastructures-js/queue.svg)](https://www.npmjs.com/package/@datastructures-js/queue)
 [![npm](https://img.shields.io/npm/dm/@datastructures-js/queue.svg)](https://www.npmjs.com/packages/@datastructures-js/queue) [![npm](https://img.shields.io/badge/node-%3E=%206.0-blue.svg)](https://www.npmjs.com/package/@datastructures-js/queue)
 
@@ -14,16 +13,16 @@ A performant queue implementation in javascript.
 * [import](#import)
 * [API](#api)
   * [constructor](#constructor)
-  * [Queue.fromArray(elements)](#queuefromarrayelements)
-  * [.enqueue(element)](#enqueueelement)
-  * [.front()](#front)
-  * [.back()](#back)
-  * [.dequeue()](#dequeue)
-  * [.isEmpty()](#isEmpty)
-  * [.size()](#size)
-  * [.clone()](#clone)
-  * [.toArray()](#toarray)
-  * [.clear()](#clear)
+  * [Queue.fromArray](#queuefromarray)
+  * [enqueue](#enqueue)
+  * [front](#front)
+  * [back](#back)
+  * [dequeue](#dequeue)
+  * [isEmpty](#isEmpty)
+  * [size](#size)
+  * [clone](#clone)
+  * [toArray](#toarray)
+  * [clear](#clear)
 * [Build](#build)
 * [License](#license)
 
@@ -67,7 +66,7 @@ const queue = new Queue<number>();
 const queue = new Queue<number>([1, 2, 3]);
 ```
 
-### Queue.fromArray(elements)
+### Queue.fromArray
 
 ##### JS
 ```js
@@ -92,142 +91,63 @@ const list = [10, 3, 8, 40, 1];
 const queue = Queue.fromArray<number>(list);
 ```
 
-### .enqueue(element)
+### enqueue
 adds an element at the back of the queue.
 
-<table>
-  <tr>
-    <th align="center">params</th>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">element: T</td>
-    <td align="center">Queue&lt;T&gt;</td>
-    <td align="center">O(1)</td>
-  </tr>
-</table>
-
 ```js
 queue.enqueue(10).enqueue(20);
 ```
 
-### .front()
+### front
 peeks on the front element of the queue.
 
-<table>
-  <tr>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">T</td>
-    <td align="center">O(1)</td>
-  </tr>
-</table>
-
 ```js
 console.log(queue.front()); // 10
 ```
 
-### .back()
+### back
 peeks on the back element in the queue.
 
-<table>
-  <tr>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">T</td>
-    <td align="center">O(1)</td>
-  </tr>
-</table>
-
 ```js
 console.log(queue.back()); // 20
 ```
 
-### .dequeue()
-dequeue the front element in the queue. It does not use *.shift()* to dequeue the element. Instead, it uses a pointer to get the front element and only remove elements when reaching half size of the queue.
-
-<table>
-  <tr>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">T</td>
-    <td align="center">O(n*log(n))</td>
-  </tr>
-</table>
+### dequeue
+dequeue the front element in the queue.
 
 ```js
 console.log(queue.dequeue()); // 10
 console.log(queue.front()); // 20
 ```
 
-Dequeuing all elements takes <i>O(n\*log(n))</i> instead of <i>O(n<sup>2</sup>)</i> when using shift(). 
+Dequeuing all elements takes <i>O(n\*log(n))</i> instead of <i>O(n<sup>2</sup>)</i> when using shift/unshift with arrays.
 
 <b>benchmark:</b>
 
 dequeuing 1 million elements in Node v12
 
 <table>
- <tr><td>.dequeue()</td><td>.shift()</td></tr>
-  <tr><td>~ 40 ms</td><td>~ 3 minutes</td></tr>
+ <tr><td>dequeue</td><td>shift</td></tr>
+  <tr><td>~40 ms</td><td>~3 minutes</td></tr>
 </table>
 
-### .isEmpty()
+### isEmpty
 checks if the queue is empty.
 
-<table>
-  <tr>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">boolean</td>
-    <td align="center">O(1)</td>
-  </tr>
-</table>
-
 ```js
 console.log(queue.isEmpty()); // false
 ```
 
-### .size()
+### size
 returns the number of elements in the queue.
 
-<table>
-  <tr>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">number</td>
-    <td align="center">O(1)</td>
-  </tr>
-</table>
-
 ```js
 console.log(queue.size()); // 1
 ```
 
-### .clone() 
+### clone
 creates a shallow copy of the queue.
 
-<table>
-  <tr>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">Queue&lt;T&gt;</td>
-    <td align="center">O(n)</td>
-  </tr>
-</table>
-
 ```js
 const queue = Queue.fromArray([{ id: 2 }, { id: 4 } , { id: 8 }]);
 const clone =  queue.clone();
@@ -238,37 +158,17 @@ console.log(queue.front()); // { id: 2 }
 console.log(clone.front()); // { id: 4 }
 ```
 
-### .toArray() 
+### toArray 
 returns a copy of the remaining elements as an array.
 
-<table>
-  <tr>
-    <th align="center">return</th>
-    <th align="center">runtime</th>
-  </tr>
-  <tr>
-    <td align="center">T[]</td>
-    <td align="center">O(n)</td>
-  </tr>
-</table>
-
 ```js
 queue.enqueue(4).enqueue(2);
 console.log(queue.toArray()); // [20, 4, 2]
 ```
 
-### .clear()
+### clear
 clears all elements from the queue.
 
-<table>
- <tr>
-  <th>runtime</th>
- </tr>
- <tr>
-  <td>O(1)</td>
- </tr>
-</table>
-
 ```js
 queue.clear();
 queue.size(); // 0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datastructures-js/queue",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "a performant queue implementation in javascript",
   "main": "index.js",
   "scripts": {

src/queue.js

@@ -17,7 +17,7 @@ class Queue {
   /**
    * Adds an element at the back of the queue.
    * @public
-   * @param {any} element
+   * @param {number|string|object} element
    */
   enqueue(element) {
     this._elements.push(element);
@@ -27,7 +27,7 @@ class Queue {
   /**
    * Dequeues the front element in the queue.
    * @public
-   * @returns {any}
+   * @returns {number|string|object}
    */
   dequeue() {
     if (this.size() === 0) return null;
@@ -47,7 +47,7 @@ class Queue {
   /**
    * Returns the front element of the queue.
    * @public
-   * @returns {any}
+   * @returns {number|string|object}
    */
   front() {
     return this.size() > 0 ? this._elements[this._offset] : null;
@@ -56,7 +56,7 @@ class Queue {
   /**
    * Returns the back element of the queue.
    * @public
-   * @returns {any}
+   * @returns {number|string|object}
    */
   back() {
     return this.size() > 0 ? this._elements[this._elements.length - 1] : null;