controlled.md

This is RxJS v 4. Find the latest version here

Rx.Observable.prototype.controlled([enableQueue])

Ⓢ

Attaches a controller to the observable sequence with the ability to queue.

Arguments

1. [enableQueue] (Boolean): Whether to enable queueing. If not specified, defaults to true.

Returns

(Observable): An observable sequence which can be used to request values from the sequence.

Example

var source = Rx.Observable.range(0, 10).controlled();

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

source.request(2);

// => Next: 0
// => Next: 1

Location

File:

• /src/core/backpressure/controlled.js

Dist:

• rx.backpressure.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

• If using rx.backpressure.js
  • rx.js | rx.compat.js
  • rx.binding.js

NPM Packages:

• rx

NuGet Packages:

• RxJS-All
• RxJS-BackPressure
• RxJS-Lite

Unit Tests:

• /tests/observable/controlled.js