take.md

This is RxJS v 4. Find the latest version here

Rx.Observable.prototype.take(count, [scheduler])

Ⓢ

Returns a specified number of contiguous elements from the start of an observable sequence, using the specified scheduler for the edge case of take(0).

Arguments

1. count (Number): The number of elements to return.
2. [scheduler] (Scheduler): Scheduler used to produce an onCompleted message in case count is set to 0.

Returns

(Observable): An observable sequence that contains the elements before and including the specified index in the input sequence.

Example

var source = Rx.Observable.range(0, 5)
    .take(3);

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

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

Location

File:

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

Dist:

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

Prerequisites:

• None

NPM Packages:

• rx

NuGet Packages:

• RxJS-All
• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/observable/take.js