throttle.md

This is RxJS v 4. Find the latest version here

Rx.Observable.prototype.throttle(windowDuration, [scheduler])

Ⓢ

Returns an Observable that emits only the first item emitted by the source Observable during sequential time windows of a specified duration.

Arguments

1. windowDuration (Number): Time to wait before emitting another item after emitting the last item (specified as an integer denoting milliseconds).
2. [scheduler] (Scheduler): The Scheduler to use internally to manage the timers that handle timeout for each item. If not provided, defaults to the default scheduler.

Returns

(Observable): An Observable that performs the throttle operation.

Example

var times = [
  { value: 0, time: 100 },
  { value: 1, time: 600 },
  { value: 2, time: 400 },
  { value: 3, time: 900 },
  { value: 4, time: 200 }
];

// Delay each item by time and project value;
var source = Rx.Observable.from(times)
  .flatMap(function (item) {
    return Rx.Observable
      .of(item.value)
      .delay(item.time);
  })
  .throttle(300 /* ms */);

var subscription = source.subscribe(
  function (x) {
    console.log('Next: %s', x);
  },
  function (err) {
    console.log('Error: %s', err);
  },
  function () {
    console.log('Completed');
  });

// => Next: 0
// => Next: 2
// => Next: 3
// => Completed

Location

File:

• /src/core/linq/observable/throttle.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-All
• RxJS-Lite
• RxJS-Time

Unit Tests:

• /tests/observable/throttle.js