Package Exports
- @httpie/queue-datastructure
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@httpie/queue-datastructure) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Queue Datastructure
A queue data structure for Node.js.
Installation · Usage · API
Follow @eldorplus and @httpiejs for updates!
Installation
npm i @httpie/queue-datastructureUsage
Using the queue data structure is pretty straightforward. The library exposes a Queue class and you need to create a queue instance. You can create a queue from existing data or an empty one:
const Queue = require('@httpie/queue-datastructure')
// create a queue from an existing array
const queue = new Queue([ 1, 2, 3 ])
// or, create a queue from individual items
const queue = new Queue(1, 2, 3)
// or, create an empty queue
const queue = new Queue()API
.enqueue(items)
Pushes new items to the end of the queue.
queue.enqueue(1)
queue.enqueue(2, 3)
queue.enqueue([ 4, 5, 6]).dequeue()
Removes and returns the item which is up for processing. Returns undefined if the queue is empty.
queue.enqueue(1, 2, 3)
queue.size() // 3
queue.dequeue() // 1
queue.size() // 2.peek()
Returns the front item without removing it from the queue. Returns undefined if the queue is empty.
queue.enqueue(1, 2, 3)
queue.peek() // 1.size()
Returns the number of items in the queue.
queue.size() // 0
queue.enqueue(1, 2)
queue.size() // 2.isEmpty()
Returns true if there are no items in the queue, false otherwise.
queue.isEmpty() // true
queue.enqueue(1)
queue.isEmpty() // false.isNotEmpty()
Returns true if there are items in the queue, false when the queue is empty.
queue.isNotEmpty() // false
queue.enqueue(1)
queue.isNotEmpty() // true.clear()
Removes all items from the queue.
queue.clear()
queue.size() // 0Contributing
- Create a fork
- Create your feature branch:
git checkout -b my-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request 🚀
License
MIT © httpie
httpiejs.com · GitHub @httpiejs · Twitter @httpiejs