Scheduler

deprecated

An execution context and a data structure to order tasks and schedule their execution. Provides a notion of (potentially virtual) time, through the now() getter method.

Each unit of work in a Scheduler is called an Action.

class Scheduler {
  now(): number;
  schedule(work, delay?, state?): Subscription;
}

@deprecated

Scheduler is an internal implementation detail of RxJS, and should not be used directly. Rather, create your own class and implement SchedulerLike. Will be made internal in v8.

class Scheduler implements SchedulerLike {

constructor(schedulerActionCtor: Action, now?: () => number);

private schedulerActionCtor;

now: () => number;

schedule<T>(

work: (this: SchedulerAction<T>, state?: T) => void,

delay?: number,

state?: T,

): Subscription;

static now: () => number;

}

§Implements

SchedulerLike

[src]

§Constructors

new Scheduler(schedulerActionCtor: Action, now?: () => number)

[src]

§Properties

schedulerActionCtor

[src]

now: () => number

[src]

A getter method that returns a number representing the current time (at the time this function was called) according to the scheduler's own internal clock.

§Methods

schedule<T>(work: (this: SchedulerAction<T>, state?: T) => void, delay?: number, state?: T): Subscription

[src]

Schedules a function, work, for execution. May happen at some point in the future, according to the delay parameter, if specified. May be passed some context object, state, which will be passed to the work function.

The given arguments will be processed an stored as an Action object in a queue of actions.

@param work

A function representing a task, or some unit of work to be executed by the Scheduler.

@return

A subscription in order to be able to unsubscribe the scheduled work.

§Static Properties

now: () => number

[src]