1.0.0 • Published 5 years ago

dl-queue-ts v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

Queue Data-Structure for TypeScript

This is a queue data-structure implementation for TypeScript using a doubly linked-list from the package dl-doubly-linked-list version 1.0.3 or greater.

Installation

npm install dl-queue-ts

API

Constructor

let q : Queue<T> = new Queue();

Properties

NameTypeDescription
lengthnumberNumber of elements in the queue.

Methods

NameParamTypeDescription
clearnoneEmpties the queue.
peekindexnumberReturns the element stored at the index position. Throws exception if index is out of bounds.
popnonePops the top most emlement in the queue.
pushelementTPushes an element of type T (generic) into the queue.

Documentation

Please refer to doc/index.html for the complete documentation and API reference. The documentation for this project was generated using Compodoc.

Demo

let q : Queue<number> = new Queue();

// Pushes elements into the queue
for(let i=0; i<10; i++) {
    q.push(i*3);
}

// Gets the elements in an array
let nums : Array<number|null> = queue.toArray();

// Pops an element from the queue
let n : number = q.pop();

// Peek into the array
n = q.peek(3);

// Throws an exception for out of bounds for index
n = q.peek(33);

// Empties the array
q.clear();