1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
import { MonoTypeOperatorFunction } from '../types';
/**
* The Max operator operates on an Observable that emits numbers (or items that can be compared with a provided function),
* and when source Observable completes it emits a single item: the item with the largest value.
*
* 
*
* ## Examples
* Get the maximal value of a series of numbers
* ```javascript
* import { of } from 'rxjs';
* import { max } from 'rxjs/operators';
*
* of(5, 4, 7, 2, 8).pipe(
* max(),
* )
* .subscribe(x => console.log(x)); // -> 8
* ```
*
* Use a comparer function to get the maximal item
* ```typescript
* import { of } from 'rxjs';
* import { max } from 'rxjs/operators';
*
* interface Person {
* age: number,
* name: string
* }
* of<Person>(
* {age: 7, name: 'Foo'},
* {age: 5, name: 'Bar'},
* {age: 9, name: 'Beer'},
* ).pipe(
* max<Person>((a: Person, b: Person) => a.age < b.age ? -1 : 1),
* )
* .subscribe((x: Person) => console.log(x.name)); // -> 'Beer'
* ```
*
* @see {@link min}
*
* @param {Function} [comparer] - Optional comparer function that it will use instead of its default to compare the
* value of two items.
* @return {Observable} An Observable that emits item with the largest value.
* @method max
* @owner Observable
*/
export declare function max<T>(comparer?: (x: T, y: T) => number): MonoTypeOperatorFunction<T>;
|
