Skip to content

Latest commit

 

History

History
82 lines (66 loc) · 2.61 KB

sample.md

File metadata and controls

82 lines (66 loc) · 2.61 KB

Rx.Observable.prototype.sample(interval | sampleObservable)

Samples the observable sequence at each interval.

Arguments

  1. [interval] (Number): Interval at which to sample (specified as an integer denoting milliseconds)
  2. [sampleObservable] (Observable): Sampler Observable.
  3. [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:

NPM Packages:

NuGet Packages:

Unit Tests: