Learn RxJS
Search…
auditTime
signature: auditTime(duration: number, scheduler?: Scheduler): Observable
auditTime(duration: number, scheduler?: Scheduler): ObservableIgnore for given time then emit most recent value
Why use auditTime
auditTimeWhen you are interested in ignoring a source observable for a given amount of time, you can use
auditTime. A possible use case is to only emit certain events (i.e. mouse clicks) at a maximum rate per second. After the specified duration has passed, the timer is disabled and the most recent source value is emitted on the output Observable, and this process repeats for the next source value.💡 If you want the timer to reset whenever a new event occurs on the source observable, you can use debounceTime
Examples
Example 1: Emit clicks at a rate of at most one click per second
1
import { fromEvent } from 'rxjs';
2
import { auditTime } from 'rxjs/operators';
3
4
// Create observable that emits click events
5
const source = fromEvent(document, 'click');
6
// Emit clicks at a rate of at most one click per second
7
const example = source.pipe(auditTime(1000))
8
// Output (example): '(1s) --- Clicked --- (1s) --- Clicked'
9
const subscribe = example.subscribe(val => console.log('Clicked'));
Copied!
Additional Resources
- 📰 - Official docs
Last modified 1yr ago