docs(groupBy): Add documentation for groupBy operator #139
Conversation
Codecov Report
@@ Coverage Diff @@
## master #139 +/- ##
=======================================
Coverage 88.46% 88.46%
=======================================
Files 7 7
Lines 78 78
Branches 7 7
=======================================
Hits 69 69
Misses 6 6
Partials 3 3Continue to review full report at Codecov.
|
btroncone
left a comment
btroncone
left a comment
There was a problem hiding this comment.
Thanks for your contribution! Just a few comments. 👍
| { | ||
| name: "Pivot data on the id field", | ||
| code: ` | ||
| Rx.Observable.of<Obj>({id: 1, name: 'aze1'}, |
There was a problem hiding this comment.
This appears invalid, did you mean <Object>?
There was a problem hiding this comment.
Well, no, I wanted to indicate a specific object, named Obj, defined this way in TypeScript:
interface Obj {
id number;
name: string;
}
| { | ||
| name: "Group objects by id and return as array", | ||
| code: ` | ||
| Rx.Observable.of<Obj>({id: 1, name: 'aze1'}, |
There was a problem hiding this comment.
See other comment regarding Object
| shortDescription: { | ||
| description: ` | ||
| Group, according to a specified key, elements from items emitted by an Observable, | ||
| and emit these grouped items as GroupedObservables, one GroupedObservable per group. |
There was a problem hiding this comment.
Is there something we can link to here for GroupedObservable that provides a better explanation? Since it is mentioned several times in the explanation I think it would be easy to get lost within an understanding of this concept.
There was a problem hiding this comment.
Sure, I added some explanation about GroupedObservable.
|
@feloy can you update your branch pls? Otherwise, thx for this awesome Pr |
|
@ladyleet Hi, I think it's updated now. |
|
Thx @feloy! Merged! Thx @ashwin-sureshkumar for peeping at this PR. |
5 participants
Refs #116