Socket
Socket
Sign inDemoInstall

yocto-queue

Package Overview
Dependencies
0
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    yocto-queue

Tiny queue data structure


Version published
Weekly downloads
45M
increased by1.82%
Maintainers
1
Install size
7.30 kB
Created
Weekly downloads
 

Package description

What is yocto-queue?

The yocto-queue npm package is a minimalistic queue with an array-like interface. It is designed to be a tiny, performant FIFO (First In, First Out) queue implementation for managing a list of items in a sequential order.

What are yocto-queue's main functionalities?

Enqueue

Adds elements to the end of the queue.

const Queue = require('yocto-queue');
const queue = new Queue();
queue.enqueue('unicorn');
queue.enqueue('rainbow');

Dequeue

Removes and returns the first element from the queue.

const Queue = require('yocto-queue');
const queue = new Queue();
queue.enqueue('unicorn');
queue.enqueue('rainbow');
const firstItem = queue.dequeue();

Clear

Clears the queue.

const Queue = require('yocto-queue');
const queue = new Queue();
queue.enqueue('unicorn');
queue.enqueue('rainbow');
queue.clear();

Size

Returns the number of elements in the queue.

const Queue = require('yocto-queue');
const queue = new Queue();
queue.enqueue('unicorn');
queue.enqueue('rainbow');
const size = queue.size;

Peek

Returns the first element in the queue without removing it.

const Queue = require('yocto-queue');
const queue = new Queue();
queue.enqueue('unicorn');
queue.enqueue('rainbow');
const firstItem = queue.peek();

Other packages similar to yocto-queue

Readme

Source

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.

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

Keywords

FAQs

Last updated on 12 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc