Merge pull request #24 from datastructures-js/add_push_pop

Add push/pop

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.2.0] - 2022-05-30
+### Added
+- push & pop as synonyms for enqueue & dequeue
+
 ## [4.1.4] - 2022-05-15
 ### Fixed
 - README

README.md

@@ -14,10 +14,10 @@ A performant queue implementation in javascript.
 * [API](#api)
   * [constructor](#constructor)
   * [Queue.fromArray](#queuefromarray)
-  * [enqueue](#enqueue)
+  * [enqueue (push)](#enqueue-push)
   * [front](#front)
   * [back](#back)
-  * [dequeue](#dequeue)
+  * [dequeue (pop)](#dequeue-pop)
   * [isEmpty](#isEmpty)
   * [size](#size)
   * [clone](#clone)
@@ -91,11 +91,11 @@ const list = [10, 3, 8, 40, 1];
 const queue = Queue.fromArray<number>(list);
 ```
 
-### enqueue
-adds an element at the back of the queue.
+### enqueue (push)
+adds an element to the back of the queue.
 
 ```js
-queue.enqueue(10).enqueue(20);
+queue.enqueue(10).enqueue(20); // or queue.push(123)
 ```
 
 ### front
@@ -112,11 +112,11 @@ peeks on the back element in the queue.
 console.log(queue.back()); // 20
 ```
 
-### dequeue
-dequeue the front element in the queue.
+### dequeue (pop)
+removes and returns the front element of the queue.
 
 ```js
-console.log(queue.dequeue()); // 10
+console.log(queue.dequeue()); // 10 // or queue.pop()
 console.log(queue.front()); // 20
 ```
 

package.json

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

src/queue.js

@@ -15,7 +15,7 @@ class Queue {
   }
 
   /**
-   * Adds an element at the back of the queue.
+   * Adds an element to the back of the queue.
    * @public
    * @param {number|string|object} element
    */
@@ -24,6 +24,15 @@ class Queue {
     return this;
   }
 
+  /**
+   * Adds an element to the back of the queue.
+   * @public
+   * @param {number|string|object} element
+   */
+  push(element) {
+    return this.enqueue(element);
+  }
+
   /**
    * Dequeues the front element in the queue.
    * @public
@@ -44,6 +53,15 @@ class Queue {
     return first;
   }
 
+  /**
+   * Dequeues the front element in the queue.
+   * @public
+   * @returns {number|string|object}
+   */
+  pop() {
+    return this.dequeue();
+  }
+
   /**
    * Returns the front element of the queue.
    * @public

test/queue.test.js

@@ -22,7 +22,7 @@ describe('Queue unit tests', () => {
     it('should enqueue 3 elements to the stack', () => {
       queue.enqueue(1);
       queue.enqueue(8);
-      queue.enqueue(45);
+      queue.push(45);
     });
   });
 
@@ -73,7 +73,7 @@ describe('Queue unit tests', () => {
   describe('dequeue()', () => {
     it('should dequeue all elements', () => {
       expect(queue.dequeue()).to.be.equal(8);
-      expect(queue.dequeue()).to.be.equal(45);
+      expect(queue.pop()).to.be.equal(45);
     });
   });