X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FQueue.html;h=68883fdbf19329d5c516207745cc8ac2dcf5cd45;hb=df7349e2151c2e46d0bf2c406a5d8bd14d1ed2bf;hp=d490ca6e50aa72e5b0795543e2d757ac5aee1300;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html index d490ca6e..68883fdb 100644 --- a/docs/classes/Queue.html +++ b/docs/classes/Queue.html @@ -1,4 +1,4 @@ -
Private
headPrivate
itemsPrivate
maxPrivate
tailGenerated using TypeDoc
Get the maximum size of the queue.
+The maximum size of the queue.
Returns number
The maximum size of the queue.
--- Defined in src/queue.ts:37
+Private
offset+- Defined in src/queue.ts:10
size
+The size of the queue.
++- Defined in src/queue.ts:12
Methods
+[iterator]
-- get size(): number
+- [iterator](): Iterator<T, any, undefined>
-
-
-
+
+
+
+
-
-- Defined in src/queue.ts:68
+- Defined in src/queue.ts:40
+- Defined in src/queue.ts:26
- peek(): undefined | T
-
-
-
+ - Defined in src/queue.ts:58
@@ -188,17 +191,17 @@
- constructor
-- head
- items
-- max
-- tail
-- max
Size
-- size
+- max
Size
+- offset
+- size
+- [iterator]
+- clear
- dequeue
- enqueue
- peek
-
+ - Worker
Types
+- available
Parallelism
Get the size of the queue.
+Returns an iterator for the queue.
Returns number
The size of the queue.
+Returns Iterator<T, any, undefined>
An iterator for the queue.
+See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
++- Defined in src/queue.ts:81
clear
++- clear(): void
+-
+
+
Clears the queue.
+Returns void
-- Defined in src/queue.ts:27
Methods
+dequeue
@@ -136,7 +138,7 @@
-- Defined in src/queue.ts:59
enqueue
@@ -156,18 +158,19 @@
-- Defined in src/queue.ts:47
peek
Peek at the first item.
+Peeks at the first item.
Returns undefined | T
+Returns undefined | T
The first item or
+undefined
if the queue is empty.-- Defined in src/queue.ts:75