Job Components: `Index Queue`
index.Queue
A basic FIFO queue
Type parameters
Name |
---|
T |
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new Queue<T
>(): Queue
<T
>
Type parameters
Name |
---|
T |
Returns
Queue
<T
>
Properties
head
• Optional
head: default
<T
>
Defined in
packages/utils/dist/src/queue/index.d.ts:4
tail
• Optional
tail: default
<T
>
Defined in
packages/utils/dist/src/queue/index.d.ts:5
Methods
dequeue
▸ dequeue(): undefined
| T
Returns
undefined
| T
Defined in
packages/utils/dist/src/queue/index.d.ts:10
each
▸ each(fn
): void
Iterate over each value
Parameters
Name | Type |
---|---|
fn | (value : T ) => void |
Returns
void
Defined in
packages/utils/dist/src/queue/index.d.ts:12
enqueue
▸ enqueue(value
): void
A value to the end of the queue
Parameters
Name | Type |
---|---|
value | T |
Returns
void
Defined in
packages/utils/dist/src/queue/index.d.ts:8
exists
▸ exists(key
, val
): boolean
Search the queue to see if a key value pair exists
Parameters
Name | Type |
---|---|
key | string |
val | unknown |
Returns
boolean
Defined in
packages/utils/dist/src/queue/index.d.ts:25
extract
▸ extract(key
, val
): undefined
| T
Search the queue for a key that matches a value and return the match
Parameters
Name | Type |
---|---|
key | string |
val | unknown |
Returns
undefined
| T
Defined in
packages/utils/dist/src/queue/index.d.ts:17
remove
▸ remove(id
, keyForID?
): void
Parameters
Name | Type |
---|---|
id | string |
keyForID? | string |
Returns
void
Defined in
packages/utils/dist/src/queue/index.d.ts:13
size
▸ size(): number
Get the length of the queue
Returns
number
Defined in
packages/utils/dist/src/queue/index.d.ts:21
unshift
▸ unshift(value
): void
Parameters
Name | Type |
---|---|
value | T |
Returns
void
Defined in
packages/utils/dist/src/queue/index.d.ts:9