Last change
on this file since 1ad8e64 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago |
initial commit
|
-
Property mode
set to
100644
|
File size:
2.0 KB
|
Line | |
---|
1 | # yocto-queue [![](https://badgen.net/bundlephobia/minzip/yocto-queue)](https://bundlephobia.com/result?p=yocto-queue)
|
---|
2 |
|
---|
3 | > Tiny queue data structure
|
---|
4 |
|
---|
5 | 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](https://medium.com/@ariel.salem1989/an-easy-to-use-guide-to-big-o-time-complexity-5dcf4be8a444#:~:text=O(N)%E2%80%94Linear%20Time) *O(n)* while `Queue#dequeue()` has [constant time complexity](https://medium.com/@ariel.salem1989/an-easy-to-use-guide-to-big-o-time-complexity-5dcf4be8a444#:~:text=O(1)%20%E2%80%94%20Constant%20Time) *O(1)*. That makes a huge difference for large arrays.
|
---|
6 |
|
---|
7 | > A [queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)) 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](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics))) principle.
|
---|
8 |
|
---|
9 | ## Install
|
---|
10 |
|
---|
11 | ```
|
---|
12 | $ npm install yocto-queue
|
---|
13 | ```
|
---|
14 |
|
---|
15 | ## Usage
|
---|
16 |
|
---|
17 | ```js
|
---|
18 | const Queue = require('yocto-queue');
|
---|
19 |
|
---|
20 | const queue = new Queue();
|
---|
21 |
|
---|
22 | queue.enqueue('🦄');
|
---|
23 | queue.enqueue('🌈');
|
---|
24 |
|
---|
25 | console.log(queue.size);
|
---|
26 | //=> 2
|
---|
27 |
|
---|
28 | console.log(...queue);
|
---|
29 | //=> '🦄 🌈'
|
---|
30 |
|
---|
31 | console.log(queue.dequeue());
|
---|
32 | //=> '🦄'
|
---|
33 |
|
---|
34 | console.log(queue.dequeue());
|
---|
35 | //=> '🌈'
|
---|
36 | ```
|
---|
37 |
|
---|
38 | ## API
|
---|
39 |
|
---|
40 | ### `queue = new Queue()`
|
---|
41 |
|
---|
42 | The instance is an [`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols), 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.
|
---|
43 |
|
---|
44 | #### `.enqueue(value)`
|
---|
45 |
|
---|
46 | Add a value to the queue.
|
---|
47 |
|
---|
48 | #### `.dequeue()`
|
---|
49 |
|
---|
50 | Remove the next value in the queue.
|
---|
51 |
|
---|
52 | Returns the removed value or `undefined` if the queue is empty.
|
---|
53 |
|
---|
54 | #### `.clear()`
|
---|
55 |
|
---|
56 | Clear the queue.
|
---|
57 |
|
---|
58 | #### `.size`
|
---|
59 |
|
---|
60 | The size of the queue.
|
---|
61 |
|
---|
62 | ## Related
|
---|
63 |
|
---|
64 | - [quick-lru](https://github.com/sindresorhus/quick-lru) - Simple “Least Recently Used” (LRU) cache
|
---|
Note:
See
TracBrowser
for help on using the repository browser.