import { Operator } from '../Operator'; import { Subscriber } from '../Subscriber'; import { Subscription } from '../Subscription'; import { async } from '../scheduler/async'; import { Observable } from '../Observable'; import { ThrottleConfig, defaultThrottleConfig } from './throttle'; import { MonoTypeOperatorFunction, SchedulerLike, TeardownLogic } from '../types'; /** * Emits a value from the source Observable, then ignores subsequent source * values for `duration` milliseconds, then repeats this process. * * <span class="informal">Lets a value pass, then ignores source values for the * next `duration` milliseconds.</span> * *  * * `throttleTime` 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. After `duration` milliseconds (or the time unit determined * internally by the optional `scheduler`) has passed, the timer is disabled, * and this process repeats for the next source value. Optionally takes a * {@link SchedulerLike} for managing timers. * * ## Examples * * #### Limit click rate * * Emit clicks at a rate of at most one click per second * ```ts * import { fromEvent } from 'rxjs'; * import { throttleTime } from 'rxjs/operators'; * * const clicks = fromEvent(document, 'click'); * const result = clicks.pipe(throttleTime(1000)); * result.subscribe(x => console.log(x)); * ``` * * #### Double Click * * The following example only emits clicks which happen within a subsequent * delay of 400ms of the previous click. This for example can emulate a double * click. It makes use of the `trailing` parameter of the throttle configuration. * * ```ts * import { fromEvent, asyncScheduler } from 'rxjs'; * import { throttleTime, withLatestFrom } from 'rxjs/operators'; * * // defaultThottleConfig = { leading: true, trailing: false } * const throttleConfig = { * leading: false, * trailing: true * } * * const click = fromEvent(document, 'click'); * const doubleClick = click.pipe( * throttleTime(400, asyncScheduler, throttleConfig) * ); * * doubleClick.subscribe((throttleValue: Event) => { * console.log(`Double-clicked! Timestamp: ${throttleValue.timeStamp}`); * }); * ``` * * If you enable the `leading` parameter in this example, the output would be the primary click and * the double click, but restricts additional clicks within 400ms. * * @see {@link auditTime} * @see {@link debounceTime} * @see {@link delay} * @see {@link sampleTime} * @see {@link throttle} * * @param {number} duration Time to wait before emitting another value after * emitting the last value, measured in milliseconds or the time unit determined * internally by the optional `scheduler`. * @param {SchedulerLike} [scheduler=async] The {@link SchedulerLike} to use for * managing the timers that handle the throttling. * @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 throttleTime * @owner Observable */ export function throttleTime<T>(duration: number, scheduler: SchedulerLike = async, config: ThrottleConfig = defaultThrottleConfig): MonoTypeOperatorFunction<T> { return (source: Observable<T>) => source.lift(new ThrottleTimeOperator(duration, scheduler, config.leading, config.trailing)); } class ThrottleTimeOperator<T> implements Operator<T, T> { constructor(private duration: number, private scheduler: SchedulerLike, private leading: boolean, private trailing: boolean) { } call(subscriber: Subscriber<T>, source: any): TeardownLogic { return source.subscribe( new ThrottleTimeSubscriber(subscriber, this.duration, this.scheduler, this.leading, this.trailing) ); } } /** * We need this JSDoc comment for affecting ESDoc. * @ignore * @extends {Ignored} */ class ThrottleTimeSubscriber<T> extends Subscriber<T> { private throttled: Subscription; private _hasTrailingValue: boolean = false; private _trailingValue: T = null; constructor(destination: Subscriber<T>, private duration: number, private scheduler: SchedulerLike, private leading: boolean, private trailing: boolean) { super(destination); } protected _next(value: T) { if (this.throttled) { if (this.trailing) { this._trailingValue = value; this._hasTrailingValue = true; } } else { this.add(this.throttled = this.scheduler.schedule<DispatchArg<T>>(dispatchNext, this.duration, { subscriber: this })); if (this.leading) { this.destination.next(value); } else if (this.trailing) { this._trailingValue = value; this._hasTrailingValue = true; } } } protected _complete() { if (this._hasTrailingValue) { this.destination.next(this._trailingValue); this.destination.complete(); } else { this.destination.complete(); } } clearThrottle() { const throttled = this.throttled; if (throttled) { if (this.trailing && this._hasTrailingValue) { this.destination.next(this._trailingValue); this._trailingValue = null; this._hasTrailingValue = false; } throttled.unsubscribe(); this.remove(throttled); this.throttled = null; } } } interface DispatchArg<T> { subscriber: ThrottleTimeSubscriber<T>; } function dispatchNext<T>(arg: DispatchArg<T>) { const { subscriber } = arg; subscriber.clearThrottle(); }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
audit.ts | File | 4.14 KB | 0644 |
|
auditTime.ts | File | 2.38 KB | 0644 |
|
buffer.ts | File | 2.54 KB | 0644 |
|
bufferCount.ts | File | 4.46 KB | 0644 |
|
bufferTime.ts | File | 8.51 KB | 0644 |
|
bufferToggle.ts | File | 5.6 KB | 0644 |
|
bufferWhen.ts | File | 3.89 KB | 0644 |
|
catchError.ts | File | 4.72 KB | 0644 |
|
combineAll.ts | File | 2.44 KB | 0644 |
|
combineLatest.ts | File | 4.32 KB | 0644 |
|
concat.ts | File | 2.18 KB | 0644 |
|
concatAll.ts | File | 2.26 KB | 0644 |
|
concatMap.ts | File | 3.4 KB | 0644 |
|
concatMapTo.ts | File | 3.05 KB | 0644 |
|
count.ts | File | 3.78 KB | 0644 |
|
debounce.ts | File | 4.88 KB | 0644 |
|
debounceTime.ts | File | 4.54 KB | 0644 |
|
defaultIfEmpty.ts | File | 2.69 KB | 0644 |
|
delay.ts | File | 5.09 KB | 0644 |
|
delayWhen.ts | File | 7.7 KB | 0644 |
|
dematerialize.ts | File | 2.58 KB | 0644 |
|
distinct.ts | File | 4.22 KB | 0644 |
|
distinctUntilChanged.ts | File | 3.76 KB | 0644 |
|
distinctUntilKeyChanged.ts | File | 2.79 KB | 0644 |
|
elementAt.ts | File | 2.56 KB | 0644 |
|
endWith.ts | File | 4.06 KB | 0644 |
|
every.ts | File | 2.54 KB | 0644 |
|
exhaust.ts | File | 3.2 KB | 0644 |
|
exhaustMap.ts | File | 5.64 KB | 0644 |
|
expand.ts | File | 6.18 KB | 0644 |
|
filter.ts | File | 3.69 KB | 0644 |
|
finalize.ts | File | 1.3 KB | 0644 |
|
find.ts | File | 3.81 KB | 0644 |
|
findIndex.ts | File | 1.86 KB | 0644 |
|
first.ts | File | 3.36 KB | 0644 |
|
groupBy.ts | File | 9.95 KB | 0644 |
|
ignoreElements.ts | File | 1.49 KB | 0644 |
|
index.ts | File | 4.02 KB | 0644 |
|
isEmpty.ts | File | 2.67 KB | 0644 |
|
last.ts | File | 2.36 KB | 0644 |
|
map.ts | File | 3.04 KB | 0644 |
|
mapTo.ts | File | 1.9 KB | 0644 |
|
materialize.ts | File | 3.25 KB | 0644 |
|
max.ts | File | 1.54 KB | 0644 |
|
merge.ts | File | 3.59 KB | 0644 |
|
mergeAll.ts | File | 2.43 KB | 0644 |
|
mergeMap.ts | File | 6.28 KB | 0644 |
|
mergeMapTo.ts | File | 2.56 KB | 0644 |
|
mergeScan.ts | File | 4.65 KB | 0644 |
|
min.ts | File | 1.54 KB | 0644 |
|
multicast.ts | File | 3.46 KB | 0644 |
|
observeOn.ts | File | 5.17 KB | 0644 |
|
onErrorResumeNext.ts | File | 8.18 KB | 0644 |
|
pairwise.ts | File | 2.43 KB | 0644 |
|
partition.ts | File | 2.68 KB | 0644 |
|
pluck.ts | File | 3.07 KB | 0644 |
|
publish.ts | File | 2.51 KB | 0644 |
|
publishBehavior.ts | File | 589 B | 0644 |
|
publishLast.ts | File | 2.06 KB | 0644 |
|
publishReplay.ts | File | 1.47 KB | 0644 |
|
race.ts | File | 1.85 KB | 0644 |
|
reduce.ts | File | 3.71 KB | 0644 |
|
refCount.ts | File | 5 KB | 0644 |
|
repeat.ts | File | 3.03 KB | 0644 |
|
repeatWhen.ts | File | 4.15 KB | 0644 |
|
retry.ts | File | 2.74 KB | 0644 |
|
retryWhen.ts | File | 3.45 KB | 0644 |
|
sample.ts | File | 2.78 KB | 0644 |
|
sampleTime.ts | File | 3.18 KB | 0644 |
|
scan.ts | File | 4.13 KB | 0644 |
|
sequenceEqual.ts | File | 5.16 KB | 0644 |
|
share.ts | File | 1.02 KB | 0644 |
|
shareReplay.ts | File | 4.19 KB | 0644 |
|
single.ts | File | 3.79 KB | 0644 |
|
skip.ts | File | 1.27 KB | 0644 |
|
skipLast.ts | File | 2.81 KB | 0644 |
|
skipUntil.ts | File | 3.81 KB | 0644 |
|
skipWhile.ts | File | 1.95 KB | 0644 |
|
startWith.ts | File | 4.35 KB | 0644 |
|
subscribeOn.ts | File | 2.56 KB | 0644 |
|
switchAll.ts | File | 1.99 KB | 0644 |
|
switchMap.ts | File | 6.04 KB | 0644 |
|
switchMapTo.ts | File | 2.56 KB | 0644 |
|
take.ts | File | 2.74 KB | 0644 |
|
takeLast.ts | File | 3.44 KB | 0644 |
|
takeUntil.ts | File | 2.79 KB | 0644 |
|
takeWhile.ts | File | 3.87 KB | 0644 |
|
tap.ts | File | 5.33 KB | 0644 |
|
throttle.ts | File | 4.83 KB | 0644 |
|
throttleTime.ts | File | 5.83 KB | 0644 |
|
throwIfEmpty.ts | File | 2.19 KB | 0644 |
|
timeInterval.ts | File | 2.49 KB | 0644 |
|
timeout.ts | File | 4.07 KB | 0644 |
|
timeoutWith.ts | File | 6.13 KB | 0644 |
|
timestamp.ts | File | 1.67 KB | 0644 |
|
toArray.ts | File | 1.12 KB | 0644 |
|
window.ts | File | 3.72 KB | 0644 |
|
windowCount.ts | File | 4.82 KB | 0644 |
|
windowTime.ts | File | 9.9 KB | 0644 |
|
windowToggle.ts | File | 6.2 KB | 0644 |
|
windowWhen.ts | File | 4.57 KB | 0644 |
|
withLatestFrom.ts | File | 7.72 KB | 0644 |
|
zip.ts | File | 3.35 KB | 0644 |
|
zipAll.ts | File | 653 B | 0644 |
|