Class AsyncQueue

Name

AsyncQueue

Description

A queue to process async works in sequence, only one work is processed at a time

Index

Constructors

Properties

_currentWork? _working _works

Accessors

Methods

cancel cancelCurrentWork clear dequeue enqueue

Constructors

constructor

new AsyncQueue(): AsyncQueue
Returns AsyncQueue
- Defined in packages/utils/src/queue/AsyncQueue.ts:16

Properties

`Protected` `Optional`_currentWork

_currentWork?: Work

`Protected`_working

_working: boolean

`Protected`_works

_works: Work[]

Accessors

isWorking

get isWorking(): boolean
Returns boolean
- Defined in packages/utils/src/queue/AsyncQueue.ts:68

size

get size(): number
Returns number
- Defined in packages/utils/src/queue/AsyncQueue.ts:64

Methods

cancel

cancel(): void
Cancel the current work & clear the queue

Returns void
- Defined in packages/utils/src/queue/AsyncQueue.ts:48

cancelCurrentWork

cancelCurrentWork(): void
Cancel the current work if there is any work is going on

Returns void
- Defined in packages/utils/src/queue/AsyncQueue.ts:56

clear

clear(): void
Clear the pending works queue

Returns void
- Defined in packages/utils/src/queue/AsyncQueue.ts:37

`Protected`dequeue

dequeue(): Promise<void>
Returns Promise<void>
- Defined in packages/utils/src/queue/AsyncQueue.ts:72

enqueue

enqueue<T>(work): Promise<T>
Enqueue a work to be processed
Type Parameters
- T = any
Parameters
- work: WorkItem<T>
Returns Promise<T>
- Defined in packages/utils/src/queue/AsyncQueue.ts:26