sample.md

This is RxJS v 4. Find the latest version here

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:

• /src/core/linq/observable/sample.js

Dist:

• rx.all.js
• rx.all.compat.js
• rx.time.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

• If using rx.time.js
  • rx.js | rx.compat.js

NPM Packages:

• rx

NuGet Packages:

• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/observable/sample.js