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.
142 lines
5.8 KiB
142 lines
5.8 KiB
"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 OuterSubscriber_1 = require('../OuterSubscriber'); |
|
var subscribeToResult_1 = require('../util/subscribeToResult'); |
|
exports.defaultThrottleConfig = { |
|
leading: true, |
|
trailing: false |
|
}; |
|
/** |
|
* Emits a value from the source Observable, then ignores subsequent source |
|
* values for a duration determined by another Observable, then repeats this |
|
* process. |
|
* |
|
* <span class="informal">It's like {@link throttleTime}, but the silencing |
|
* duration is determined by a second Observable.</span> |
|
* |
|
* <img src="./img/throttle.png" width="100%"> |
|
* |
|
* `throttle` emits the source Observable values on the output Observable |
|
* when its internal timer is disabled, and ignores source values when the timer |
|
* is enabled. Initially, the timer is disabled. As soon as the first source |
|
* value arrives, it is forwarded to the output Observable, and then the timer |
|
* is enabled by calling the `durationSelector` function with the source value, |
|
* which returns the "duration" Observable. When the duration Observable emits a |
|
* value or completes, the timer is disabled, and this process repeats for the |
|
* next source value. |
|
* |
|
* @example <caption>Emit clicks at a rate of at most one click per second</caption> |
|
* var clicks = Rx.Observable.fromEvent(document, 'click'); |
|
* var result = clicks.throttle(ev => Rx.Observable.interval(1000)); |
|
* result.subscribe(x => console.log(x)); |
|
* |
|
* @see {@link audit} |
|
* @see {@link debounce} |
|
* @see {@link delayWhen} |
|
* @see {@link sample} |
|
* @see {@link throttleTime} |
|
* |
|
* @param {function(value: T): SubscribableOrPromise} durationSelector A function |
|
* that receives a value from the source Observable, for computing the silencing |
|
* duration for each source value, returned as an Observable or a Promise. |
|
* @param {Object} config a configuration object to define `leading` and `trailing` behavior. Defaults |
|
* to `{ leading: true, trailing: false }`. |
|
* @return {Observable<T>} An Observable that performs the throttle operation to |
|
* limit the rate of emissions from the source. |
|
* @method throttle |
|
* @owner Observable |
|
*/ |
|
function throttle(durationSelector, config) { |
|
if (config === void 0) { config = exports.defaultThrottleConfig; } |
|
return function (source) { return source.lift(new ThrottleOperator(durationSelector, config.leading, config.trailing)); }; |
|
} |
|
exports.throttle = throttle; |
|
var ThrottleOperator = (function () { |
|
function ThrottleOperator(durationSelector, leading, trailing) { |
|
this.durationSelector = durationSelector; |
|
this.leading = leading; |
|
this.trailing = trailing; |
|
} |
|
ThrottleOperator.prototype.call = function (subscriber, source) { |
|
return source.subscribe(new ThrottleSubscriber(subscriber, this.durationSelector, this.leading, this.trailing)); |
|
}; |
|
return ThrottleOperator; |
|
}()); |
|
/** |
|
* We need this JSDoc comment for affecting ESDoc |
|
* @ignore |
|
* @extends {Ignored} |
|
*/ |
|
var ThrottleSubscriber = (function (_super) { |
|
__extends(ThrottleSubscriber, _super); |
|
function ThrottleSubscriber(destination, durationSelector, _leading, _trailing) { |
|
_super.call(this, destination); |
|
this.destination = destination; |
|
this.durationSelector = durationSelector; |
|
this._leading = _leading; |
|
this._trailing = _trailing; |
|
this._hasTrailingValue = false; |
|
} |
|
ThrottleSubscriber.prototype._next = function (value) { |
|
if (this.throttled) { |
|
if (this._trailing) { |
|
this._hasTrailingValue = true; |
|
this._trailingValue = value; |
|
} |
|
} |
|
else { |
|
var duration = this.tryDurationSelector(value); |
|
if (duration) { |
|
this.add(this.throttled = subscribeToResult_1.subscribeToResult(this, duration)); |
|
} |
|
if (this._leading) { |
|
this.destination.next(value); |
|
if (this._trailing) { |
|
this._hasTrailingValue = true; |
|
this._trailingValue = value; |
|
} |
|
} |
|
} |
|
}; |
|
ThrottleSubscriber.prototype.tryDurationSelector = function (value) { |
|
try { |
|
return this.durationSelector(value); |
|
} |
|
catch (err) { |
|
this.destination.error(err); |
|
return null; |
|
} |
|
}; |
|
/** @deprecated internal use only */ ThrottleSubscriber.prototype._unsubscribe = function () { |
|
var _a = this, throttled = _a.throttled, _trailingValue = _a._trailingValue, _hasTrailingValue = _a._hasTrailingValue, _trailing = _a._trailing; |
|
this._trailingValue = null; |
|
this._hasTrailingValue = false; |
|
if (throttled) { |
|
this.remove(throttled); |
|
this.throttled = null; |
|
throttled.unsubscribe(); |
|
} |
|
}; |
|
ThrottleSubscriber.prototype._sendTrailing = function () { |
|
var _a = this, destination = _a.destination, throttled = _a.throttled, _trailing = _a._trailing, _trailingValue = _a._trailingValue, _hasTrailingValue = _a._hasTrailingValue; |
|
if (throttled && _trailing && _hasTrailingValue) { |
|
destination.next(_trailingValue); |
|
this._trailingValue = null; |
|
this._hasTrailingValue = false; |
|
} |
|
}; |
|
ThrottleSubscriber.prototype.notifyNext = function (outerValue, innerValue, outerIndex, innerIndex, innerSub) { |
|
this._sendTrailing(); |
|
this._unsubscribe(); |
|
}; |
|
ThrottleSubscriber.prototype.notifyComplete = function () { |
|
this._sendTrailing(); |
|
this._unsubscribe(); |
|
}; |
|
return ThrottleSubscriber; |
|
}(OuterSubscriber_1.OuterSubscriber)); |
|
//# sourceMappingURL=throttle.js.map
|