Class PromiseQueue

A queue that manages its items with promises.

Package

@augment-vir/common

Hierarchy

ListenTarget<PromiseQueueUpdateEvent>
- PromiseQueue

Index

Constructors

Properties

currentlyAwaiting queue

Accessors

Methods

add handleItemSettle triggerNextQueueItem

Constructors

constructor

new PromiseQueue(): PromiseQueue
Returns PromiseQueue
Inherited from ListenTarget<PromiseQueueUpdateEvent>.constructor

Properties

`Protected`currentlyAwaiting

currentlyAwaiting: undefined | PromiseQueueItem<any> = undefined

`Protected`queue

queue: PromiseQueueItem<any>[] = []

Accessors

size

get size(): number
The current size of the queue.

Returns number
- Defined in packages/common/src/augments/promise/promise-queue.ts:61

Methods

add

add<T = void>(item: () => MaybePromise<T>): Promise<T>
Add an item to the queue.
Type Parameters
- T = void
Parameters
- item: () => MaybePromise<T>
Returns Promise<T>
A promise that resolves at the same time as the added item.
- Defined in packages/common/src/augments/promise/promise-queue.ts:70

`Protected`handleItemSettle

handleItemSettle(
    __namedParameters: RequireExactlyOne<
        { rejection: unknown; resolution: unknown },
    >,
): PromiseQueueItem<any>
Handles a queue item finishing, whether it be a rejection or a resolution.
Parameters
- __namedParameters: RequireExactlyOne<{ rejection: unknown; resolution: unknown }>
Returns PromiseQueueItem<any>
- Defined in packages/common/src/augments/promise/promise-queue.ts:92

`Protected`triggerNextQueueItem

triggerNextQueueItem(): boolean
Tries to trigger the next queue item, if there is one.

Returns boolean
Whether a new queue item was triggered or not. true if it was, otherwise false.
- Defined in packages/common/src/augments/promise/promise-queue.ts:129