lifo v0.0.2

LIFO

Table of Contents

• LIFO
  • Summary
  • Installation
  • Usage
  • Building
  • Testing
  • Documentation
  • Build + Test + Document
  • Contributing
  • Author
  • License

Summary

This is a LIFO (stack) implementation along with all the basic operations that come with it. Currently these operations are supported on the stack data structure:

• size : get the count of elements on the stack
• isEmpty: check if the stack is empty or not
• push : push a element on the stack (returns the size after pushing)
• peek : peek (without removing) the element that the next pop call will return
• pop : pop and get the last pushed element from the stack

Installation

$ npm install lifo

Usage

Here is a example usage (output are shown in comments):

var lifo = require('lifo');

lifo.push('some string');
console.log(lifo.peek());  // some string
lifo.push(100);
console.log(lifo.size());  // 2
console.log(lifo.pop());   // 100

Debug

If you want to enable debug output for this module, just set environment variable DEBUG to "lifo". This will print log messages that might look like this (taken from the test output of this module):

Building

To get the js source generated form coffee script:

$ grunt coffee

This will put all js files in lib folder.

Testing

To execute tests, make sure grunt is installed. Then run:

$ grunt test

Before testing, this task will perform a lint check using coffeelint. Tests will be executed if and only if linting succeeds.

The default task of grunt will run this command as well. So, just typing grunt and pressing RET is also sufficient to run tests.

Documentation

Documentation is generated using docco and placed in docs folder. To build documentation:

$ grunt docs

Build + Test + Document

The build task of grunt will check linting, test everything, generate docs and build javascript source. So, to execute:

$ grunt build

Contributing

Feel free to make a change and issue a pull request if you have a patch.

If you have a feature request or if you find a bug, please open a issue.

Author

Anshul Verma :: anshulverma :: @anshulverma

License

The MIT License (MIT)

Copyright (c) 2014 Anshul Verma

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.