44 lines
1.6 KiB
JavaScript
44 lines
1.6 KiB
JavaScript
|
"use strict";
|
||
|
|
var __extends = (this && this.__extends) || function (d, b) {
|
||
|
|
for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
|
||
|
|
function __() { this.constructor = d; }
|
||
|
|
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
||
|
|
};
|
||
|
|
var Subscription_1 = require('../Subscription');
|
||
|
|
/**
|
||
|
|
* A unit of work to be executed in a {@link Scheduler}. An action is typically
|
||
|
|
* created from within a Scheduler 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>
|
||
|
|
*/
|
||
|
|
var Action = (function (_super) {
|
||
|
|
__extends(Action, _super);
|
||
|
|
function Action(scheduler, work) {
|
||
|
|
_super.call(this);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Schedules this action on its parent Scheduler 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}
|
||
|
|
*/
|
||
|
|
Action.prototype.schedule = function (state, delay) {
|
||
|
|
if (delay === void 0) { delay = 0; }
|
||
|
|
return this;
|
||
|
|
};
|
||
|
|
return Action;
|
||
|
|
}(Subscription_1.Subscription));
|
||
|
|
exports.Action = Action;
|
||
|
|
//# sourceMappingURL=Action.js.map
|