Class AsyncSeq

Run async functions in sequence.

Index

Constructors

constructor

Accessors

full running size

Methods

dispose flush schedule wait

Constructors

constructor

new AsyncSeq(options?: AsyncSeqOptions): AsyncSeq
Parameters
- Optionaloptions: AsyncSeqOptions
Returns AsyncSeq
- Defined in async-seq.ts:54

Accessors

full

get full(): boolean
Is sequence full.

Returns boolean
- Defined in async-seq.ts:29

running

get running(): boolean
Is sequence running.

Returns boolean
- Defined in async-seq.ts:35

size

get size(): number
Size of pending tasks in the sequence.

Returns number
- Defined in async-seq.ts:42

Methods

dispose

dispose(): Promise<void>
Dispose the sequence.

Returns Promise<void>
- Defined in async-seq.ts:63

flush

flush(): Promise<void>
Returns Promise<void>
- Defined in async-seq.ts:67

schedule

schedule(...fns: AsyncSeqFn[]): Promise<void>
Add task executors to the sequence.
Parameters
- ...fns: AsyncSeqFn[]
  
  Task executors. Optionally returns a disposer function that cleans up side effects.
Returns Promise<void>

Promise that resolves when all tasks in the sequence are executed.
- Defined in async-seq.ts:81

wait

wait(): Promise<void>
Wait for the sequence to finish.

Returns Promise<void>
- Defined in async-seq.ts:93

On This Page