Documentation

Class: Scheduler

Scheduler

rgjs6 Scheduler class.

new Scheduler( [opts])

Parameters:
Name Type Argument Default Description
opts Object <optional>
 {}
Properties
Name Type Argument Default Description
debug Boolean <optional>
 false

Members

<static> Constants :Constants

Type:
  • Constants

<static> SubScheduler :SubScheduler

Type:

<static> Task :Task

Type:

Methods

abort()

Abort any pending tasks.

createSubScheduler()

Create a sub-scheduler.

postTask(fn [, taskOpts] [, opts])

Add a task to the scheduler.

Parameters:
Name Type Argument Default Description
fn Task | function
taskOpts Object <optional>
 {}
opts Object <optional>
 {}
Properties
Name Type Argument Default Description
unshift Boolean <optional>
 false
Returns:

Resolves when the task has finished.

Type
Promise

postTasks(fns [, taskOpts] [, opts])

Add an array of tasks to the scheduler.

Parameters:
Name Type Argument Default Description
fns Array
taskOpts Object <optional>
 {}
opts Object <optional>
 {}
Properties
Name Type Argument Default Description
unshift Boolean <optional>
 false
Returns:

Resolves when all tasks in fns have finished.

Type
Promise