Merge pull request #10 from datastructures-js/development

v2.0.4

Author: eyas-ranjous

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.4] - 2020-12-26
+### Fixed
+- jsdoc
+- readme
+
 ## [2.0.3] - 2020-04-03
 ### Fixed
 - .npmignore

README.md

@@ -8,9 +8,9 @@ A wrapper around javascript array push/pop with a standard stack interface.
 
 # Table of Contents
 * [Install](#install)
+* [require](#require)
+* [import](#import)
 * [API](#api)
-  * [require](#require)
-  * [import](#import)
   * [Construction](#construction)
   * [.push(element)](#pushelement)
   * [.peek()](#peek)
@@ -29,25 +29,20 @@ A wrapper around javascript array push/pop with a standard stack interface.
 npm install --save @datastructures-js/stack
 ```
 
-## API
-
 ### require
-
 ```js
 const Stack = require('@datastructures-js/stack');
 ```
 
 ### import
-
 ```js
 import Stack from '@datastructures-js/stack';
 ```
+## API
 
 ### Construction
 
-#### using "new Stack(array)"
-
-##### Example
+#### using "new"
 
 ```js
 // empty stack
@@ -57,9 +52,7 @@ const stack = new Stack();
 const stack = new Stack([10, 3, 8, 40, 1]);
 ```
 
-#### using "Stack.fromArray(array)"
-
-##### Example
+#### using ".fromArray"
 
 ```js
 // empty stack
@@ -69,8 +62,8 @@ const stack = Stack.fromArray([]);
 const list = [10, 3, 8, 40, 1];
 const stack = Stack.fromArray(list);
 
-// If the list should not be mutated, simply construct the stack from a copy of it.
-const stack = Stack.fromArray(list.slice(0));
+// If the list should not be mutated, use a copy of it.
+const stack = Stack.fromArray(list.slice());
 ```
 
 ### .push(element)
@@ -79,7 +72,7 @@ push an element to the top of the stack.
 <table>
   <tr><th align="center" colspan="2">params</th></tr>
  <tr><td><b>name</b></td><td><b>type</b></td></tr>
-  <tr><td>element</td><td>object</td></tr>
+  <tr><td>element</td><td>any</td></tr>
 </table>
 
 <table>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datastructures-js/stack",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "stack implementation in javascript",
   "main": "index.js",
   "scripts": {

src/stack.js

@@ -1,39 +1,39 @@
 /**
- * @datastructures-js/stack
- * @copyright 2020 Eyas Ranjous <eyas.ranjous@gmail.com>
  * @license MIT
- */
-
-/**
- * @class Stack
- * implements LIFO principle.
+ * @copyright 2020 Eyas Ranjous <eyas.ranjous@gmail.com>
+ *
+ * @class
  */
 class Stack {
+  /**
+   * Creates a stack.
+   * @param {array} [elements]
+   */
   constructor(elements) {
     this._elements = Array.isArray(elements) ? elements : [];
   }
 
   /**
+   * Checks if the stack is empty.
    * @public
-   * checks if the stack is empty
    * @returns {boolean}
    */
   isEmpty() {
     return this._elements.length === 0;
   }
 
   /**
+   * Returns the number of elements in the stack.
    * @public
-   * returns the number of elements in the stack
    * @returns {number}
    */
   size() {
     return this._elements.length;
   }
 
   /**
+   * Returns the top element in the stack.
    * @public
-   * returns the top element in the stack
    * @returns {object}
    */
   peek() {
@@ -43,17 +43,17 @@ class Stack {
   }
 
   /**
+   * Adds an element to the top of the stack.
    * @public
-   * adds an element to the top of the stack
    * @param {object} element
    */
   push(element) {
     this._elements.push(element);
   }
 
   /**
+   * Removes and returns the top element in the stack.
    * @public
-   * removes and returns the top element in the stack
    * @returns {object}
    */
   pop() {
@@ -63,36 +63,36 @@ class Stack {
   }
 
   /**
+   * Returns the remaining elements as an array.
    * @public
-   * returns the remaining elements as an array
    * @returns {array}
    */
   toArray() {
-    return this._elements.slice(0);
+    return this._elements.slice();
   }
 
   /**
+   * Clears all elements from the stack.
    * @public
-   * clears all elements from the stack
    */
   clear() {
     this._elements = [];
   }
 
   /**
+   * Creates a shallow copy from the stack.
    * @public
-   * creates a shallow copy from the stack
    * @return {Stack}
    */
   clone() {
-    return new Stack(this._elements.slice(0));
+    return new Stack(this._elements.slice());
   }
 
   /**
+   * Creates a stack from an existing array
    * @public
    * @static
-   * creates a stack from an existing array
-   * @param {array} elements
+   * @param {array} [elements]
    * @return {Stack}
    */
   static fromArray(elements) {