@terascope/job-components / index / Queue
Class: Queue<T>
Defined in: packages/utils/dist/src/queue/index.d.ts:3
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? | Node<T> | packages/utils/dist/src/queue/index.d.ts:4 |
tail? | Node<T> | packages/utils/dist/src/queue/index.d.ts:5 |
Methods
dequeue()
dequeue():
undefined|T
Defined in: packages/utils/dist/src/queue/index.d.ts:10
Returns
undefined | T
each()
each(
fn):void
Defined in: packages/utils/dist/src/queue/index.d.ts:12
Iterate over each value
Parameters
| Parameter | Type |
|---|---|
fn | (value) => void |
Returns
void
enqueue()
enqueue(
value):void
Defined in: packages/utils/dist/src/queue/index.d.ts:8
A value to the end of the queue
Parameters
| Parameter | Type |
|---|---|
value | T |
Returns
void
exists()
exists(
key,val):boolean
Defined in: packages/utils/dist/src/queue/index.d.ts:25
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/dist/src/queue/index.d.ts:17
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/dist/src/queue/index.d.ts:13
Parameters
| Parameter | Type |
|---|---|
id | string |
keyForID? | string |
Returns
void
size()
size():
number
Defined in: packages/utils/dist/src/queue/index.d.ts:21
Get the length of the queue
Returns
number
unshift()
unshift(
value):void
Defined in: packages/utils/dist/src/queue/index.d.ts:9
Parameters
| Parameter | Type |
|---|---|
value | T |
Returns
void