@terascope/utils / queue / Queue
Class: Queue<T>
Defined in: packages/utils/src/queue/index.ts:4
A basic FIFO queue
Type Parameters
| Type Parameter |
|---|
T |
Constructors
new Queue()
new Queue<
T>():Queue<T>
Returns
Queue<T>
Properties
| Property | Type | Defined in |
|---|---|---|
head? | default<T> | packages/utils/src/queue/index.ts:5 |
tail? | default<T> | packages/utils/src/queue/index.ts:6 |
Methods
dequeue()
dequeue():
undefined|T
Defined in: packages/utils/src/queue/index.ts:28
Returns
undefined | T
each()
each(
fn):void
Defined in: packages/utils/src/queue/index.ts:50
Iterate over each value
Parameters
| Parameter | Type |
|---|---|
fn | (value) => void |
Returns
void
enqueue()
enqueue(
value):void
Defined in: packages/utils/src/queue/index.ts:10
A value to the end of the queue
Parameters
| Parameter | Type |
|---|---|
value | T |
Returns
void
exists()
exists(
key,val):boolean
Defined in: packages/utils/src/queue/index.ts:165
Search the queue to see if a key value pair exists
Parameters
| Parameter | Type |
|---|---|
key | string |
val | unknown |
Returns
boolean
extract()
extract(
key,val):undefined|T
Defined in: packages/utils/src/queue/index.ts:114
Search the queue for a key that matches a value and return the match
Parameters
| Parameter | Type |
|---|---|
key | string |
val | unknown |
Returns
undefined | T
remove()
remove(
id,keyForID?):void
Defined in: packages/utils/src/queue/index.ts:61
Parameters
| Parameter | Type |
|---|---|
id | string |
keyForID? | string |
Returns
void
size()
size():
number
Defined in: packages/utils/src/queue/index.ts:158
Get the length of the queue
Returns
number
unshift()
unshift(
value):void
Defined in: packages/utils/src/queue/index.ts:18
Parameters
| Parameter | Type |
|---|---|
value | T |
Returns
void