Class Queue

Hierarchy

Queue

Index

Constructors

Methods

add addEventListener addEventListenerOnce cancelBy destroy filter getQueueSize getTaskPosition getTaskWaitingPosition getTasks insertAt isTaskRunning pause prepend remove removeEventListener setConcurrency unpause

Constructors

constructor

new Queue(options?: QueueOptions): Queue
Creates an instance of Queue, optionally definint default options.
Parameters
- options: QueueOptions = {}
Returns Queue
- Defined in src/Queue.ts:70

Methods

add

add<ReturnValue>(taskFn: TaskFn<ReturnValue>, data?: {
[key: string]: unknown;
}): Task<ReturnValue>
Adds a task to the queue.

Returns
- a Task wrapper for your task function
Throws
Error - when queue is destroyed
Type Parameters
- ReturnValue
Parameters
- taskFn: TaskFn<ReturnValue>
  
  task function
- Optional data: {
  [key: string]: unknown;
  }
  
  data related to task, used for filtering tasks in the queue
  - [key: string]: unknown
Returns Task<ReturnValue>
- Defined in src/Queue.ts:253

addEventListener

addEventListener<T>(eventName: T, fn: EventsTypes[T]): (() => void)
Adds specified queue event listener.

Returns
- unsubscribe function, call it to remove event listener
Throws
Error - when queue is destroyed or unknown event name is given
Type Parameters
- T extends EVENTS
Parameters
- eventName: T
- fn: EventsTypes[T]
  
  listener
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/Queue.ts:193

addEventListenerOnce

addEventListenerOnce<T>(eventName: T, fn: EventsTypes[T]): (() => void)
Adds specified queue event listener that will be called only on first occurrence of event after adding.

Returns
- unsubscribe function, call it to remove event listener
Throws
Error - when queue is destroyed or unknown event name is given
Type Parameters
- T extends EVENTS
Parameters
- eventName: T
- fn: EventsTypes[T]
  
  listener
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/Queue.ts:211

cancelBy

cancelBy(fn: FilterFn): Task<any>[]
Cancels tasks by predicate

Returns
- cancelled tasks
Parameters
- fn: FilterFn
  
  filtering function
Returns Task<any>[]
- Defined in src/Queue.ts:361

destroy

destroy(): QueueDestroyInfo
Destroys queue. Destroying removes waiting tasks, ongoing tasks are continued. You may manually cancel them. Destroyed instance won't allow you to do anything with it anymore.

Returns
- list of removed and ongoing tasks
Returns QueueDestroyInfo
- Defined in src/Queue.ts:98

filter

filter(fn: FilterFn): Task<any>[]
Returns tasks by filtering function.

Returns
Parameters
- fn: FilterFn
  
  filtering function
Returns Task<any>[]
- Defined in src/Queue.ts:348

getQueueSize

getQueueSize(): number
Returns queue size.

Returns number
- Defined in src/Queue.ts:331

getTaskPosition

getTaskPosition<V>(task: Task<V>): number
Returns given task position in the queue (this includes running tasks)

Returns
- task index or -1 if not found
Type Parameters
- V
Parameters
- task: Task<V>
  
  task to look for
Returns number
- Defined in src/Queue.ts:372

getTaskWaitingPosition

getTaskWaitingPosition<V>(task: Task<V>): number
Returns given task waiting position, 0 means the task will be first to run next time a free slot is ready

Returns
- task index or -1 if not found (ie: already done, already running)
Type Parameters
- V
Parameters
- task: Task<V>
  
  task to look for
Returns number
- Defined in src/Queue.ts:381

getTasks

getTasks(): Task<any>[]
Returns current tasks (ongoing and waiting).

Returns

Returns Task<any>[]
- Defined in src/Queue.ts:339

insertAt

insertAt<V>(taskFn: TaskFn<V>, index: number, data?: {
[key: string]: unknown;
}): Task<V>
Adds a task to given point of the queue.

Returns

Throws
Error - when queue is destroyed
Type Parameters
- V
Parameters
- taskFn: TaskFn<V>
  
  task function
- index: number
  
  task position in the queue (starting from 0). Keep in mind that ongoing tasks are kept in this list, ie: with concurrency of 2 adding task to index 2 will mean this task will be first to run, not third.
- Optional data: {
  [key: string]: unknown;
  }
  
  data related to task, used for filtering tasks in the queue
  - [key: string]: unknown
Returns Task<V>
- Defined in src/Queue.ts:292

isTaskRunning

isTaskRunning<V>(task: Task<V>): boolean
Is given task running?

Returns
- true if task is running, false otherwise
Type Parameters
- V
Parameters
- task: Task<V>
  
  task to check
Returns boolean
- Defined in src/Queue.ts:390

pause

pause(): void
Pauses the queue, all running tasks will continue, but new ones won't start. Unpause queue with .unpause().

See
unpause()

Returns void
- Defined in src/Queue.ts:398

prepend

prepend<V>(taskFn: TaskFn<V>, data?: {
[key: string]: unknown;
}): Task<V>
Adds a task to beginning of the queue.

Returns

Throws
Error - when queue is destroyed
Type Parameters
- V
Parameters
- taskFn: TaskFn<V>
  
  task function
- Optional data: {
  [key: string]: unknown;
  }
  
  data related to task, used for filtering tasks in the queue
  - [key: string]: unknown
Returns Task<V>
- Defined in src/Queue.ts:271

remove

remove<V>(task: Task<V>): void
Removes queue from task. This won't cancel ongoing task.

Throws
- when task isn't in the queue or queue is destroyed
Type Parameters
- V
Parameters
- task: Task<V>
Returns void
- Defined in src/Queue.ts:308

removeEventListener

removeEventListener<T>(eventName: T, fn: EventsTypes[T]): void
Removes specified queue event listener.

Throws
Error - when queue is destroyed or unknown event name is given
Type Parameters
- T extends EVENTS
Parameters
- eventName: T
- fn: EventsTypes[T]
  
  listener
Returns void
- Defined in src/Queue.ts:228

setConcurrency

setConcurrency(concurrency: number): void
Changes how many tasks may run at once.
Parameters
- concurrency: number
  
  count of tasks to run at once
Returns void
- Defined in src/Queue.ts:240

unpause

unpause(): void
Unpauses the queue, tasks will be started to fill up concurrency limit.

See
pause()

Returns void
- Defined in src/Queue.ts:406

Class Queue

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

options: QueueOptions = {}

Returns Queue

Methods

add

Returns

Throws

Type Parameters

ReturnValue

Parameters

taskFn: TaskFn<ReturnValue>

Optional data: { [key: string]: unknown; }

[key: string]: unknown

Returns Task<ReturnValue>

addEventListener

Returns

Throws

Type Parameters

T extends EVENTS

Parameters

eventName: T

fn: EventsTypes[T]

Returns (() => void)

Returns void

addEventListenerOnce

Returns

Throws

Type Parameters

T extends EVENTS

Parameters

eventName: T

fn: EventsTypes[T]

Returns (() => void)

Returns void

cancelBy

Returns

Parameters

fn: FilterFn

Returns Task<any>[]

destroy

Returns

Returns QueueDestroyInfo

filter

Returns

Parameters

fn: FilterFn

Returns Task<any>[]

getQueueSize

Returns number

getTaskPosition

Returns

Type Parameters

V

Parameters

task: Task<V>

Returns number

getTaskWaitingPosition

Returns

Type Parameters

V

Parameters

task: Task<V>

Returns number

getTasks

Returns

Returns Task<any>[]

insertAt

Returns

Throws

Type Parameters

V

Parameters

taskFn: TaskFn<V>

`Optional` data: {
[key: string]: unknown;
}

`Optional` data: {
[key: string]: unknown;
}

`Optional` data: {
[key: string]: unknown;
}