File size: 2,530 Bytes
bc20498 |
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
import { distinctUntilChanged } from './distinctUntilChanged';
import { MonoTypeOperatorFunction } from '../types';
/* tslint:disable:max-line-length */
export function distinctUntilKeyChanged<T>(key: keyof T): MonoTypeOperatorFunction<T>;
export function distinctUntilKeyChanged<T, K extends keyof T>(key: K, compare: (x: T[K], y: T[K]) => boolean): MonoTypeOperatorFunction<T>;
/* tslint:enable:max-line-length */
/**
* Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item,
* using a property accessed by using the key provided to check if the two items are distinct.
*
* If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.
*
* If a comparator function is not provided, an equality check is used by default.
*
* ## Examples
*
* An example comparing the name of persons
*
* ```ts
* import { of, distinctUntilKeyChanged } from 'rxjs';
*
* of(
* { age: 4, name: 'Foo' },
* { age: 7, name: 'Bar' },
* { age: 5, name: 'Foo' },
* { age: 6, name: 'Foo' }
* ).pipe(
* distinctUntilKeyChanged('name')
* )
* .subscribe(x => console.log(x));
*
* // displays:
* // { age: 4, name: 'Foo' }
* // { age: 7, name: 'Bar' }
* // { age: 5, name: 'Foo' }
* ```
*
* An example comparing the first letters of the name
*
* ```ts
* import { of, distinctUntilKeyChanged } from 'rxjs';
*
* of(
* { age: 4, name: 'Foo1' },
* { age: 7, name: 'Bar' },
* { age: 5, name: 'Foo2' },
* { age: 6, name: 'Foo3' }
* ).pipe(
* distinctUntilKeyChanged('name', (x, y) => x.substring(0, 3) === y.substring(0, 3))
* )
* .subscribe(x => console.log(x));
*
* // displays:
* // { age: 4, name: 'Foo1' }
* // { age: 7, name: 'Bar' }
* // { age: 5, name: 'Foo2' }
* ```
*
* @see {@link distinct}
* @see {@link distinctUntilChanged}
*
* @param {string} key String key for object property lookup on each item.
* @param {function} [compare] Optional comparison function called to test if an item is distinct from the previous item in the source.
* @return A function that returns an Observable that emits items from the
* source Observable with distinct values based on the key specified.
*/
export function distinctUntilKeyChanged<T, K extends keyof T>(key: K, compare?: (x: T[K], y: T[K]) => boolean): MonoTypeOperatorFunction<T> {
return distinctUntilChanged((x: T, y: T) => compare ? compare(x[key], y[key]) : x[key] === y[key]);
}
|