Class PromiseQueue

A queue that manages its items with promises.

Package

@augment-vir/common

Hierarchy

ListenTarget<PromiseQueueUpdateEvent>
- PromiseQueue

Index

Constructors

Properties

currentlyAwaiting queue queueItemIds

Accessors

Methods

add handleItemSettle hasItemById 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>[] = []

`Protected`queueItemIds

queueItemIds: Set<PropertyKey> = ...

Accessors

size

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

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

Methods

add

add<T = void>(item: () => MaybePromise<T>, id?: PropertyKey): Promise<T>
Add an item to the queue. Only await this if you want to wait for the promise to be added and resolved (or rejected).
Type Parameters
- T = void
Parameters
- item: () => MaybePromise<T>
- Optionalid: PropertyKey
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:73

`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:110

hasItemById

hasItemById(id: PropertyKey): boolean
Checks if the given id is currently in the queue.
Parameters
- id: PropertyKey
Returns boolean
true if the item is in the queue and has not been resolved or rejected. false if the item has never been in the queue or has been resolved / rejected from the queue.
- Defined in packages/common/src/augments/promise/promise-queue.ts:105

`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:150