max.md

This is RxJS v 4. Find the latest version here

Rx.Observable.prototype.max([comparer])

Ⓢ

Returns the maximum value in an observable sequence according to the specified comparer.

Arguments

1. [comparer] (Function): Comparer used to compare elements.

Returns

(Observable): An observable sequence containing a single element with the maximum element in the source sequence.

Example

/* Without comparer */
var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8])
    .max();

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

// => Next: 9
// => Completed

/* With a comparer */
function comparer (x, y) {
    if (x > y) {
        return 1;
    } else if (x < y) {
        return -1;
    }
    return 0;
}

var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8])
    .max(comparer);

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

// => Next: 9
// => Completed

Location

File:

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

Dist:

• rx.all.js
• rx.all.compat.js
• rx.aggregates.js

Prerequisites:

• rx.lite.js | rx.compat.js | rx.lite.js | rx.lite.compat.js

NPM Packages:

• rx

NuGet Packages:

• RxJS-All
• RxJS-Aggregates

Unit Tests:

• /tests/observable/max.js