Need help with yocto-queue?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus
195 Stars 7 Forks MIT License 5 Commits 0 Opened issues

Description

Tiny queue data structure

Services available

!
?

Need anything else?

Contributors list

# 218
node
exec
test-fr...
nextjs
4 commits
# 6,610
chalk
exec
vuejs2
sketch-...
1 commit

yocto-queue

Tiny queue data structure

You should use this package instead of an array if you do a lot of

Array#push()
and
Array#shift()
on large arrays, since
Array#shift()
has linear time complexity O(n) while
Queue#dequeue()
has constant time complexity O(1). That makes a huge difference for large arrays.

A queue is an ordered list of elements where an element is inserted at the end of the queue and is removed from the front of the queue. A queue works based on the first-in, first-out (FIFO) principle.

Install

$ npm install yocto-queue

Usage

import Queue from 'yocto-queue';

const queue = new Queue();

queue.enqueue('🦄'); queue.enqueue('🌈');

console.log(queue.size); //=> 2

console.log(...queue); //=> '🦄 🌈'

console.log(queue.dequeue()); //=> '🦄'

console.log(queue.dequeue()); //=> '🌈'

API

queue = new Queue()

The instance is an

Iterable
, which means you can iterate over the queue front to back with a “for…of” loop, or use spreading to convert the queue to an array. Don't do this unless you really need to though, since it's slow.

.enqueue(value)

Add a value to the queue.

.dequeue()

Remove the next value in the queue.

Returns the removed value or

undefined
if the queue is empty.

.clear()

Clear the queue.

.size

The size of the queue.

Related

  • quick-lru - Simple “Least Recently Used” (LRU) cache

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.