X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FQueue.html;h=058fc55b482e03d9ca9fe40bcdbfe8e2ad2cc576;hb=04cb7adbacc7fb0d1b76db6122f86c52e33d136d;hp=4f19db242854706cf2b6fc90e23abe939db5f003;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html index 4f19db24..058fc55b 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
--- get size(): number
--
-
size: number
+
-
+- Defined in src/queue.ts:12
+
+- Defined in src/queue.ts:40
+- Defined in src/queue.ts:26
- peek(): undefined | T
-
-
-
+ - Defined in src/queue.ts:58
@@ -188,17 +176,16 @@
- constructor
-- head
- items
-- max
-- tail
-- max
Size
-- size
+- max
Size
+- offset
+- size
+- clear
- dequeue
- enqueue
- peek
-
+ - Worker
Types
+- available
Parallelism
Get the size of the queue.
+The size of the queue.
Returns number
The size of the queue.
--- Defined in src/queue.ts:27
Methods
+clear
++- clear(): void
+-
+
+
+
Clears the queue.
+Returns void
++- Defined in src/queue.ts:68
dequeue
@@ -136,7 +123,7 @@
-- Defined in src/queue.ts:59
enqueue
@@ -156,18 +143,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