44 lines
2.0 KiB
TypeScript
44 lines
2.0 KiB
TypeScript
|
import { IScheduler } from '../Scheduler';
|
||
|
|
import { ThrottleConfig } from './throttle';
|
||
|
|
import { MonoTypeOperatorFunction } from '../interfaces';
|
||
|
|
/**
|
||
|
|
* 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>
|
||
|
|
*
|
||
|
|
* <img src="./img/throttleTime.png" width="100%">
|
||
|
|
*
|
||
|
|
* `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 IScheduler} for managing timers.
|
||
|
|
*
|
||
|
|
* @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.throttleTime(1000);
|
||
|
|
* result.subscribe(x => console.log(x));
|
||
|
|
*
|
||
|
|
* @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 {Scheduler} [scheduler=async] The {@link IScheduler} to use for
|
||
|
|
* managing the timers that handle the throttling.
|
||
|
|
* @return {Observable<T>} An Observable that performs the throttle operation to
|
||
|
|
* limit the rate of emissions from the source.
|
||
|
|
* @method throttleTime
|
||
|
|
* @owner Observable
|
||
|
|
*/
|
||
|
|
export declare function throttleTime<T>(duration: number, scheduler?: IScheduler, config?: ThrottleConfig): MonoTypeOperatorFunction<T>;
|