Rx.Observable.prototype.sample(interval | sampleObservable)
Samples the observable sequence at each interval.
Arguments
[interval]
(Number
): Interval at which to sample (specified as an integer denoting milliseconds)[sampleObservable]
(Observable
): Sampler Observable.[scheduler=Rx.Scheduler.timeout]
(Scheduler
): Scheduler to run the sampling timer on. If not specified, the timeout scheduler is used.
Returns
(Observable
): Sampled observable sequence.
Example
/* With an interval time */
var source = Rx.Observable.interval(1000)
.sample(5000)
.take(2);
var subscription = source.subscribe(
function (x) {
console.log('Next: ' + x);
},
function (err) {
console.log('Error: ' + err);
},
function () {
console.log('Completed');
});
// => Next: 4
// => Next: 9
// => Completed
/* With a sampler */
var source = Rx.Observable.interval(1000)
.sample(Rx.Observable.interval(5000))
.take(2);
var subscription = source.subscribe(
function (x) {
console.log('Next: ' + x);
},
function (err) {
console.log('Error: ' + err);
},
function () {
console.log('Completed');
});
// => Next: 4
// => Next: 9
// => Completed
Location
File:
Dist:
Prerequisites:
- If using
rx.time.js
NPM Packages:
NuGet Packages:
Unit Tests: