118 lines
4.6 KiB
JavaScript
118 lines
4.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 tryCatch_1 = require('../util/tryCatch');
|
|
var errorObject_1 = require('../util/errorObject');
|
|
var OuterSubscriber_1 = require('../OuterSubscriber');
|
|
var subscribeToResult_1 = require('../util/subscribeToResult');
|
|
/**
|
|
* Ignores source values for a duration determined by another Observable, then
|
|
* emits the most recent value from the source Observable, then repeats this
|
|
* process.
|
|
*
|
|
* <span class="informal">It's like {@link auditTime}, but the silencing
|
|
* duration is determined by a second Observable.</span>
|
|
*
|
|
* <img src="./img/audit.png" width="100%">
|
|
*
|
|
* `audit` is similar to `throttle`, but emits the last value from the silenced
|
|
* time window, instead of the first value. `audit` emits the most recent value
|
|
* from the source Observable on the output Observable as soon as its internal
|
|
* timer becomes disabled, and ignores source values while the timer is enabled.
|
|
* Initially, the timer is disabled. As soon as the first source value arrives,
|
|
* 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, then the most
|
|
* recent source value is emitted on the output Observable, 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.audit(ev => Rx.Observable.interval(1000));
|
|
* result.subscribe(x => console.log(x));
|
|
*
|
|
* @see {@link auditTime}
|
|
* @see {@link debounce}
|
|
* @see {@link delayWhen}
|
|
* @see {@link sample}
|
|
* @see {@link throttle}
|
|
*
|
|
* @param {function(value: T): SubscribableOrPromise} durationSelector A function
|
|
* that receives a value from the source Observable, for computing the silencing
|
|
* duration, returned as an Observable or a Promise.
|
|
* @return {Observable<T>} An Observable that performs rate-limiting of
|
|
* emissions from the source Observable.
|
|
* @method audit
|
|
* @owner Observable
|
|
*/
|
|
function audit(durationSelector) {
|
|
return function auditOperatorFunction(source) {
|
|
return source.lift(new AuditOperator(durationSelector));
|
|
};
|
|
}
|
|
exports.audit = audit;
|
|
var AuditOperator = (function () {
|
|
function AuditOperator(durationSelector) {
|
|
this.durationSelector = durationSelector;
|
|
}
|
|
AuditOperator.prototype.call = function (subscriber, source) {
|
|
return source.subscribe(new AuditSubscriber(subscriber, this.durationSelector));
|
|
};
|
|
return AuditOperator;
|
|
}());
|
|
/**
|
|
* We need this JSDoc comment for affecting ESDoc.
|
|
* @ignore
|
|
* @extends {Ignored}
|
|
*/
|
|
var AuditSubscriber = (function (_super) {
|
|
__extends(AuditSubscriber, _super);
|
|
function AuditSubscriber(destination, durationSelector) {
|
|
_super.call(this, destination);
|
|
this.durationSelector = durationSelector;
|
|
this.hasValue = false;
|
|
}
|
|
AuditSubscriber.prototype._next = function (value) {
|
|
this.value = value;
|
|
this.hasValue = true;
|
|
if (!this.throttled) {
|
|
var duration = tryCatch_1.tryCatch(this.durationSelector)(value);
|
|
if (duration === errorObject_1.errorObject) {
|
|
this.destination.error(errorObject_1.errorObject.e);
|
|
}
|
|
else {
|
|
var innerSubscription = subscribeToResult_1.subscribeToResult(this, duration);
|
|
if (innerSubscription.closed) {
|
|
this.clearThrottle();
|
|
}
|
|
else {
|
|
this.add(this.throttled = innerSubscription);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
AuditSubscriber.prototype.clearThrottle = function () {
|
|
var _a = this, value = _a.value, hasValue = _a.hasValue, throttled = _a.throttled;
|
|
if (throttled) {
|
|
this.remove(throttled);
|
|
this.throttled = null;
|
|
throttled.unsubscribe();
|
|
}
|
|
if (hasValue) {
|
|
this.value = null;
|
|
this.hasValue = false;
|
|
this.destination.next(value);
|
|
}
|
|
};
|
|
AuditSubscriber.prototype.notifyNext = function (outerValue, innerValue, outerIndex, innerIndex) {
|
|
this.clearThrottle();
|
|
};
|
|
AuditSubscriber.prototype.notifyComplete = function () {
|
|
this.clearThrottle();
|
|
};
|
|
return AuditSubscriber;
|
|
}(OuterSubscriber_1.OuterSubscriber));
|
|
//# sourceMappingURL=audit.js.map
|