throttleTime
Emits a value from the source Observable, then ignores subsequent source
values for duration
milliseconds, then repeats this process.
Parameters
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 |
Optional. Default is The |
config |
Optional. Default is a configuration object to define |
Returns
MonoTypeOperatorFunction<T>
: An Observable that performs the throttle operation to
limit the rate of emissions from the source.
Description
Lets a value pass, then ignores source values for the
next duration
milliseconds.
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
SchedulerLike
for managing timers.
Examples
Limit click rate
Emit clicks at a rate of at most one click per second
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.
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.