adds documentation

Author: amejiarosario

lib/data-structures/linked-lists/linked-list.js

@@ -1,10 +1,18 @@
 const Node = require('./node');
 
+/**
+ * Singly linked list
+ */
 class LinkedList {
   constructor() {
     this.root = null;
   }
 
+  /**
+   * Adds element to the end of the list (tail)
+   * Runtime: O(n)
+   * @param {any} value
+   */
   addLast(value) { // similar Array.push
     const node = new Node(value);
 
@@ -19,6 +27,10 @@ class LinkedList {
     }
   }
 
+  /**
+   * Removes element from the start of the list (head/root)
+   * Runtime: O(1)
+   */
   removeFirst() { // similar Array.shift
     const first = this.root;
 
@@ -28,13 +40,23 @@ class LinkedList {
     }
   }
 
+  /**
+   * Adds element to the begining of the list
+   * Runtime: O(1)
+   * @param {any} value
+   */
   addFirst(value) { // similar to Array.unshift
     const node = new Node(value);
     node.next = this.root;
     this.root = node;
   }
 
-  removeLast() { // similar to Array.pop
+  /**
+   * Removes element to the end of the list
+   * similar to Array.pop
+   * Runtime: O(n)
+   */
+  removeLast() {
     let current = this.root;
     let target;
 

lib/data-structures/linked-lists/node.js

@@ -1,3 +1,6 @@
+/**
+ * Simple node
+ */
 class Node {
   constructor(value) {
     this.value = value;