X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FQueue.html;h=f9c9ff06b00159b4198243894285dca8473943d1;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=e97c4234c9deefd7bf1d4b73390de18469282308;hpb=bf4dcb92f8d370524a2975961731fe6c4e8b083c;p=poolifier.git diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html index e97c4234..f9c9ff06 100644 --- a/docs/classes/Queue.html +++ b/docs/classes/Queue.html @@ -1,4 +1,4 @@ -Queue | poolifier

+Queue | poolifier - v2.6.19

@@ -17,20 +17,22 @@

Class Queue<T>

Queue

Type Parameters

T

Type of queue items.
-

+ +

Hierarchy

Queue

Defined in src/queue.ts:8

@@ -38,29 +40,29 @@

Constructors

constructor

new Queue<T>(): Queue<T>
new Queue<T>(): Queue<T>
Type Parameters
@@ -69,54 +71,78 @@
T

Returns Queue<T>

Defined in src/queue.ts:16

Properties

`Private` head

head: number

`Private` items

items: Record<number, T>

maxSize

maxSize: number

The maximum size of the queue.

`Private` tail

tail: number

`Private` offset

offset: number

Accessors

Defined in src/queue.ts:10

size

get size(): number
-
Get the size of the queue.
+
size
+
size: number
+
The size of the queue.

-
Returns number
The size of the queue.
-
+
- Defined in src/queue.ts:25

Defined in src/queue.ts:12

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
+
Returns an iterator for 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:68

dequeue

dequeue(): undefined | T
dequeue(): undefined | T
Dequeue an item.

-
Returns undefined | T
The dequeued item.
-
+
Returns undefined | T
The dequeued item or undefined if the queue is empty.
+ +
- Defined in src/queue.ts:47

Defined in src/queue.ts:40

enqueue

enqueue(item): number
enqueue(item): number
Enqueue an item.

@@ -126,16 +152,30 @@
item: T

Item to enqueue.
-

+ +

Returns number

The new size of the queue.

peek

peek(): undefined | T
+
Peeks at the first item.
+
+
Returns undefined | T
The first item or undefined if the queue is empty.
+ +
- Defined in src/queue.ts:35