@toolcog/util/task
Toolcog utilities
Classes
Dispatcher<EventTypes>
Extends
Emitter<EventTypes>
Type Parameters
• EventTypes extends DispatcherEvents = DispatcherEvents
Constructors
new Dispatcher()
new Dispatcher<
EventTypes>(options?):Dispatcher<EventTypes>
Parameters
• options?: DispatcherOptions
Returns
Dispatcher<EventTypes>
Overrides
Defined in
Properties
error
readonlystaticerror: typeoferror
Inherited from
Defined in
errorMonitor
readonlystaticerrorMonitor: typeoferrorMonitor
Inherited from
Defined in
Accessors
concurrency
getconcurrency():number
Returns
number
Defined in
paused
getpaused():boolean
Returns
boolean
Defined in
pending
getpending():number
Returns
number
Defined in
size
getsize():number
Returns
number
Defined in
Methods
addListener()
addListener<
Event>(event,listener,options?):this
Type Parameters
• Event extends string | number | symbol
Parameters
• event: Event
• listener: EmitListener<EventTypes[Event]>
• options?: EmitListenerOptions
Returns
this
Inherited from
Defined in
emit()
emit<
Event>(event, …args):boolean
Type Parameters
• Event extends string | number | symbol
Parameters
• event: Event
• …args: EventTypes[Event]
Returns
boolean
Inherited from
Defined in
enqueue()
enqueue<
T>(task,options?):Promise<T>
Type Parameters
• T
Parameters
• task: Task<T>
• options?: DispatchOptions
Returns
Promise<T>
Defined in
enqueueAll()
enqueueAll<
T>(tasks,options):Promise<T[]>
Type Parameters
• T
Parameters
• tasks: readonly Task<T>[]
• options: DispatchOptions = {}
Returns
Promise<T[]>
Defined in
events()
events():
IterableIterator<keyofEventTypes,any,any>
Returns
IterableIterator<keyof EventTypes, any, any>
Inherited from
Defined in
isEmpty()
isEmpty():
boolean
Returns
boolean
Defined in
isIdle()
isIdle():
boolean
Returns
boolean
Defined in
listeners()
listeners<
Event>(event):IterableIterator<EmitListener<EventTypes[Event]>,any,any>
Type Parameters
• Event extends string | number | symbol
Parameters
• event: Event
Returns
IterableIterator<EmitListener<EventTypes[Event]>, any, any>
Inherited from
Defined in
on()
on<
Event>(event,options?):AsyncIterableIterator<EventTypes[Event],any,any>
Type Parameters
• Event extends string | number | symbol
Parameters
• event: Event
• options?: EmitAsyncOptions
Returns
AsyncIterableIterator<EventTypes[Event], any, any>
Inherited from
Defined in
onAvailable()
onAvailable(
backlog):Promise<void>
Parameters
• backlog: number
Returns
Promise<void>
Defined in
once()
once<
Event>(event,options?):Promise<EventTypes[Event]>
Type Parameters
• Event extends string | number | symbol
Parameters
• event: Event
• options?: EmitAsyncOptions
Returns
Promise<EventTypes[Event]>
Inherited from
Defined in
onEmpty()
onEmpty():
Promise<void>
Returns
Promise<void>
Defined in
onIdle()
onIdle():
Promise<void>
Returns
Promise<void>
Defined in
pause()
pause():
void
Returns
void
Defined in
removeListener()
removeListener<
Event>(event,listener,options?):this
Type Parameters
• Event extends string | number | symbol
Parameters
• event: Event
• listener: EmitListener<EventTypes[Event]>
• options?: EmitListenerOptions
Returns
this
Inherited from
Defined in
resume()
resume():
void
Returns
void
Defined in
Interfaces
DispatcherOptions
Extends
Properties
captureRejections?
optionalcaptureRejections:boolean
Inherited from
EmitterOptions.captureRejections
Defined in
concurrency?
optionalconcurrency:number
The maximum number of tasks that can be concurrently executing at any given time. Used to limit the concurrency of task execution.
Default
InfinityDefined in
paused?
optionalpaused:boolean
Whether to initialize the dispatcher in the paused state. Used to defer executing tasks until Dispatcher.resume is called.
Default
falseDefined in
pendingCarryover?
optionalpendingCarryover:boolean
Whether to count pending tasks towards the rateLimit when entering
a new rate limit interval. Used to ensure that tasks started during
a previous interval are counted towards the rate limit of the next
interval if they haven’t finished executing yet.
Default
falseDefined in
Queue()?
optionalQueue: <T>() =>Queue<T>
The function used to create the dispatcher’s run queue.
Returns
Queue<T>
Default
Defined in
rateInterval?
optionalrateInterval:number
The number of milliseconds in each rate limit interval. If zero or infinite, then task execution will not be rate limited.
Default
0Defined in
rateLimit?
optionalrateLimit:number
The maximum number of tasks that can be executed in any given
rateInterval. Used to rate limit task execution. If rateLimit
is infinite, or if rateInterval is zero or infinite, then task
execution will not be rate limited.
Default
InfinityDefined in
retry?
optionalretry:number|boolean|RetryOptions
Defined in
DispatchOptions
Properties
priority?
optionalpriority:number
The execution priority of the task. Lower numeric values correspond to higher priority tasks.
Default
0Defined in
retry?
optionalretry:number|boolean|RetryOptions
Defined in
signal?
optionalsignal:null|AbortSignal
The signal used to cancel execution of the task.
Defined in
RetryOptions
Properties
factor?
optionalfactor:number
Defined in
jitter?
optionaljitter:boolean
Defined in
maxTimeout?
optionalmaxTimeout:number
Defined in
minTimeout?
optionalminTimeout:number
Defined in
onFailedAttempt()?
optionalonFailedAttempt: (reason) =>void
Parameters
• reason: unknown
Returns
void
Defined in
retries?
optionalretries:number
Defined in
shouldRetry()?
optionalshouldRetry: (reason) =>boolean
Parameters
• reason: unknown
Returns
boolean
Defined in
signal?
optionalsignal:null|AbortSignal
Defined in
TaskOptions
Properties
attempt?
optionalattempt:number
The number of times the task has been retried.
Defined in
signal?
optionalsignal:null|AbortSignal
A signal to cancel the execution of the task.
Defined in
Type Aliases
DispatcherEvents
DispatcherEvents:
object
Type declaration
[error]
[error]: [
unknown]
complete
complete: []
empty
empty: []
enqueue
enqueue: []
execute
execute: []
finish
finish: []
idle
idle: []
pause
pause: []
resume
resume: []
Defined in
Task()<T>
Task<
T>: (options) =>T|PromiseLike<T>
Type Parameters
• T = unknown
Parameters
• options: TaskOptions
Returns
T | PromiseLike<T>
Defined in
Functions
retry()
retry<
T>(task,options?):Promise<T>
Type Parameters
• T
Parameters
• task: Task<T>
• options?: RetryOptions
Returns
Promise<T>