Observable.GroupBy(TSource, TKey) Method (IObservable(TSource), Func(TSource, TKey), IEqualityComparer(TKey))

Groups the elements of an observable sequence according to a specified key selector function and comparer.

Namespace:  System.Reactive.Linq
Assembly:  System.Reactive (in System.Reactive.dll)

static member GroupBy : 
        source:IObservable<'TSource> * 
        keySelector:Func<'TSource, 'TKey> * 
        comparer:IEqualityComparer<'TKey> -> IObservable<IGroupedObservable<'TKey, 'TSource>> 

Type Parameters


The type source.


The type key.


Type: System.IObservable(TSource)
An observable sequence whose elements to group.
Type: System.Func(TSource, TKey)
A function to extract the key for each element.
Type: System.Collections.Generic.IEqualityComparer(TKey)
An equality comparer to compare keys with.

Return Value

Type: System.IObservable(IGroupedObservable(TKey, TSource))
A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IObservable(TSource). When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936.aspx or https://msdn.microsoft.com/en-us/library/bb383977.aspx.