You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
31 lines
1.3 KiB
31 lines
1.3 KiB
import { Scheduler } from '../Scheduler'; |
|
import { Subscription } from '../Subscription'; |
|
import { SchedulerAction } from '../types'; |
|
/** |
|
* A unit of work to be executed in a `scheduler`. An action is typically |
|
* created from within a {@link SchedulerLike} and an RxJS user does not need to concern |
|
* themselves about creating and manipulating an Action. |
|
* |
|
* ```ts |
|
* class Action<T> extends Subscription { |
|
* new (scheduler: Scheduler, work: (state?: T) => void); |
|
* schedule(state?: T, delay: number = 0): Subscription; |
|
* } |
|
* ``` |
|
* |
|
* @class Action<T> |
|
*/ |
|
export declare class Action<T> extends Subscription { |
|
constructor(scheduler: Scheduler, work: (this: SchedulerAction<T>, state?: T) => void); |
|
/** |
|
* Schedules this action on its parent {@link SchedulerLike} for execution. May be passed |
|
* some context object, `state`. May happen at some point in the future, |
|
* according to the `delay` parameter, if specified. |
|
* @param {T} [state] Some contextual data that the `work` function uses when |
|
* called by the Scheduler. |
|
* @param {number} [delay] Time to wait before executing the work, where the |
|
* time unit is implicit and defined by the Scheduler. |
|
* @return {void} |
|
*/ |
|
schedule(state?: T, delay?: number): Subscription; |
|
}
|
|
|