X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FQueue.html;h=6f3bdbbdb428da125333116f304875e5af76c184;hb=bff4b6ed4419b66ebeb64e73c39b0054cf015a70;hp=fb130b0b5d82f14f6291783f872896c959e24dd4;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html index fb130b0b..6f3bdbbd 100644 --- a/docs/classes/Queue.html +++ b/docs/classes/Queue.html @@ -32,7 +32,7 @@
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,12 +176,11 @@
- constructor
-- head
- items
-- max
-- tail
-- max
Size
-- size
+- max
Size
+- offset
+- size
+- clear
- dequeue
- enqueue
- peek
@@ -213,40 +200,51 @@
- Thread
Worker
- Worker
Choice Strategy Context
- Cluster
Pool Options
+- Event
Loop Utilization Measurement Statistics
- IPool
- IWorker
- IWorker
Choice Strategy
+- Measurement
Options
+- Measurement
Statistics
+- Measurement
Statistics Requirements
- Message
Value
- Pool
Info
- Pool
Options
- Promise
Response Wrapper
+- Strategy
Policy
- Task
+- Task
Error
+- Task
Performance
- Task
Statistics
+- Task
Statistics Requirements
- Tasks
Queue Options
-- Tasks
Usage
+- Thread
Pool Options
- Worker
Choice Strategy Options
- Worker
Node
- Worker
Options
-- Draft
-- Error
Handler
+- Worker
Statistics
+- Worker
Usage
+- Error
Handler
- Exit
Handler
- Kill
Behavior
+- Measurement
- Message
Handler
- Online
Handler
- Pool
Event
- Pool
Type
- Task
Functions
-- Thread
Worker With Message Channel
- Worker
Async Function
- Worker
Choice Strategy
- Worker
Function
- Worker
Sync Function
- Worker
Type
- Kill
Behaviors
+- Measurements
- Pool
Events
- Pool
Types
- Worker
Choice Strategies
-- Worker
Types
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