node-structures

node-structures

Basic Data Structures for use in JavaScript (server-side, client side)

Description

The Library provides the following Data Structure Implementations

1. Stack

Installation

Server-side: npm install node-structures

Client-side: bower install node-structures

Usage

###Stack

  const Stack = require('node-structures').Stack;
  let stack = new Stack();
  
  /**
   * Tests if this stack is empty.
   * @returns {boolean} - true if and only if this stack contains no items; false otherwise.
   */
  stack.isEmpty();
  
  /**
   * Pushes an item onto the top of this stack.
   * @param item - the item to be pushed onto this stack.
   * @return {boolean} - true if the item is pushed.
   */
  stack.push(3);
  
  /**
   * Looks at the object at the top of this stack without removing it from the stack.
   * @throws {Error} - if this stack is empty.
   * @returns {*} - the object at the top of this stack (the last item of the Vector object).
   */
  stack.peek();
  
  /**
   * Removes the object at the top of this stack and returns that object as the value of this function.
   * @throws {Error} - if this stack is empty.
   * @return {*} - the object at the top of this stack (the last item of the Vector object).
   */
  stack.pop();
  
  /**
   * Returns the size of the stack.
   * @returns {Number} - the size of the stack.
   */
  stack.size();

License

MIT