Updated documentation

linux-nerd · linux-nerd · commit 4b69e8832b40 · 2018-08-20T15:30:40.000+05:30
diff --git a/README.md b/README.md
@@ -46,6 +46,7 @@ Data structures covered so far -
 - [Graph](#graph)
 - [Queue](#queue)
 - [Linked List](#link-list)
+- [Stack](#stack)
 
 # Contribution
 Your contribution is highly appreciated. You can contribute in several ways -
@@ -242,3 +243,37 @@ Usage as spread operator
 ```js
 const items = [...list] // ['firstVal', 'Mid', 'xyz', 'secondVal']
 ```
+
+# <a name="stack"></a> Stack (Linked List Implementation)
+
+Import Stack data structure and create a list object.
+
+```js
+import { Stack } from '@js-labs/data-structures/lib/ds';
+// const { Stack } = require('@js-labs/data-structures/lib/ds')
+const stack = new Stack;
+```
+
+Get size of the stack and check if the stack is empty
+
+```js
+stack.size()  //0
+stack.isEmpty() //true
+```
+
+Push items in the stack
+
+```js
+stack.push('item1');
+stack.size()  //1
+
+stack.push('item2');
+stack.size()  //2
+```
+
+Pop items from the stack
+
+```js
+stack.pop() //item2
+stack.pop() //item1
+```
diff --git a/src/stack/stack.js b/src/stack/stack.js
@@ -9,31 +9,51 @@ export class Stack {
     this[_stack] = new LinkedList;
   }
 
+  /**
+   * getter for _stack object
+   */
   get stack() {
     return this[_stack];
   }
 
+  /**
+   * Push an item on top of the stack.
+   * Ideally the insertFirst method of linked list is called to add the item in the first position in linked list
+   * @param {any} item 
+   */
   push(item) {
     this[_stack].insertFirst(item);
   }
 
+  /**
+   * Pop the top item from the stack
+   * Ideally removeFirst method of stack is called
+   */
   pop() {
     if (!this.isEmpty()) {
       return this[_stack].removeFirst().key;
     }
-
   }
 
+  /**
+   * Returns the top item of the stack without popping it
+   */
   peek() {
     if (!this.isEmpty()) {
       return this[_stack].head.key;
     }
   }
 
+  /**
+   * Returns the size of the stack
+   */
   size() {
     return this[_stack].size();
   }
 
+  /**
+   * Checks if the stack is empty
+   */
   isEmpty() {
     return this.size() === 0;
   }

Original file line number	Diff line number	Diff line change
`@@ -9,31 +9,51 @@ export class Stack {`
`9`	`9`	`this[_stack] = new LinkedList;`
`10`	`10`	`}`
`11`	`11`
	`12`	`+ /**`
	`13`	`+ * getter for _stack object`
	`14`	`+ */`
`12`	`15`	`get stack() {`
`13`	`16`	`return this[_stack];`
`14`	`17`	`}`
`15`	`18`
	`19`	`+ /**`
	`20`	`+ * Push an item on top of the stack.`
	`21`	`+ * Ideally the insertFirst method of linked list is called to add the item in the first position in linked list`
	`22`	`+ * @param {any} item`
	`23`	`+ */`
`16`	`24`	`push(item) {`
`17`	`25`	`this[_stack].insertFirst(item);`
`18`	`26`	`}`
`19`	`27`
	`28`	`+ /**`
	`29`	`+ * Pop the top item from the stack`
	`30`	`+ * Ideally removeFirst method of stack is called`
	`31`	`+ */`
`20`	`32`	`pop() {`
`21`	`33`	`if (!this.isEmpty()) {`
`22`	`34`	`return this[_stack].removeFirst().key;`
`23`	`35`	`}`
`24`		`-`
`25`	`36`	`}`
`26`	`37`
	`38`	`+ /**`
	`39`	`+ * Returns the top item of the stack without popping it`
	`40`	`+ */`
`27`	`41`	`peek() {`
`28`	`42`	`if (!this.isEmpty()) {`
`29`	`43`	`return this[_stack].head.key;`
`30`	`44`	`}`
`31`	`45`	`}`
`32`	`46`
	`47`	`+ /**`
	`48`	`+ * Returns the size of the stack`
	`49`	`+ */`
`33`	`50`	`size() {`
`34`	`51`	`return this[_stack].size();`
`35`	`52`	`}`
`36`	`53`
	`54`	`+ /**`
	`55`	`+ * Checks if the stack is empty`
	`56`	`+ */`
`37`	`57`	`isEmpty() {`
`38`	`58`	`return this.size() === 0;`
`39`	`59`	`}`