diff --git a/src/app/operators/_operator-theme.scss b/src/app/operators/_operator-theme.scss index 91ed59cc..93387d06 100644 --- a/src/app/operators/_operator-theme.scss +++ b/src/app/operators/_operator-theme.scss @@ -9,6 +9,12 @@ $link-color: #0a6fc2; $accent: mat-color(map-get($theme, accent)); $operator-active-background: rgba($operator-active, 0.7); + .parameter-description{ + font-size: .9em; + background-color: darken($operator-active, 20%); + white-space: pre-line; + } + rx-marbles > div { text-align: center; min-width: 840px; diff --git a/src/app/operators/components/operator-header/operator-header.component.html b/src/app/operators/components/operator-header/operator-header.component.html index fc4c0e8f..5a050396 100644 --- a/src/app/operators/components/operator-header/operator-header.component.html +++ b/src/app/operators/components/operator-header/operator-header.component.html @@ -2,5 +2,13 @@ {{ operatorName }} </mat-toolbar> <mat-toolbar class="signature"> - {{ operatorSignature }} + <span class="operator">{{ operatorName }}</span>( + <span *ngFor="let parameter of operatorParameters; let f=first"> + <span *ngIf="!f">, </span> + <span class="argument" [matTooltip]="parameter | argument" [matTooltipClass]="'parameter-description'">{{parameter.name}}</span>: + <span class="type">{{parameter.type}}</span> + </span> + ) + <span *ngIf="returnValue">: </span> + <span class="type" *ngIf="returnValue"> {{returnValue}}</span> </mat-toolbar> diff --git a/src/app/operators/components/operator-header/operator-header.component.scss b/src/app/operators/components/operator-header/operator-header.component.scss index 4b2b1153..f12935e7 100644 --- a/src/app/operators/components/operator-header/operator-header.component.scss +++ b/src/app/operators/components/operator-header/operator-header.component.scss @@ -6,10 +6,26 @@ .signature { margin-bottom: 24px; + .operator{ + color: #F77669; + } + .argument{ + color: #FFFFFF; + } + .type{ + color: #80cbc4; + } } +.parameter-description{ + color: red; +} + + mat-toolbar { background: $operator-active !important; color: rgb(255, 255, 255); font-weight: normal; } + + diff --git a/src/app/operators/components/operator-header/operator-header.component.ts b/src/app/operators/components/operator-header/operator-header.component.ts index 5500bf07..9f27401e 100644 --- a/src/app/operators/components/operator-header/operator-header.component.ts +++ b/src/app/operators/components/operator-header/operator-header.component.ts @@ -1,4 +1,5 @@ import { Component, Input, ChangeDetectionStrategy } from '@angular/core'; +import { OperatorParameters } from '../../../../operator-docs'; @Component({ selector: 'app-operator-header', @@ -9,4 +10,6 @@ import { Component, Input, ChangeDetectionStrategy } from '@angular/core'; export class OperatorHeaderComponent { @Input() operatorName: string; @Input() operatorSignature: string; + @Input() operatorParameters: OperatorParameters[]; + @Input() returnValue: string; } diff --git a/src/app/operators/components/operator/operator.component.html b/src/app/operators/components/operator/operator.component.html index 9a79e5d5..28a3632a 100644 --- a/src/app/operators/components/operator/operator.component.html +++ b/src/app/operators/components/operator/operator.component.html @@ -1,6 +1,8 @@ <div *ngIf="operator"> <app-operator-header [operatorName]="operatorName" [operatorSignature]="signature" + [operatorParameters]="parameters" + [returnValue]="returnValue" [id]="operatorName" class="operator-header"> </app-operator-header> diff --git a/src/app/operators/components/operator/operator.component.ts b/src/app/operators/components/operator/operator.component.ts index b7608d0d..84f67724 100644 --- a/src/app/operators/components/operator/operator.component.ts +++ b/src/app/operators/components/operator/operator.component.ts @@ -117,6 +117,10 @@ export class OperatorComponent implements OnInit, OnDestroy { return this.operator.name; } + get returnValue() { + return this.operator.returnValue; + } + get signature(): string { return this.operator.signature || 'Signature Placeholder'; } diff --git a/src/app/operators/operators.module.ts b/src/app/operators/operators.module.ts index 97befad1..a295faa9 100644 --- a/src/app/operators/operators.module.ts +++ b/src/app/operators/operators.module.ts @@ -17,6 +17,7 @@ import { WalkthroughComponent } from './components/walkthrough/walkthrough.compo import { HighlightJsDirective } from './directives/highlight-js.directive'; import { SafeUrlPipe } from './pipes/safe-url.pipe'; import { MaterialModule } from '../material/material.module'; +import { ArgumentPipe } from './pipes/argument.pipe'; @NgModule({ declarations: [ @@ -31,7 +32,8 @@ import { MaterialModule } from '../material/material.module'; WalkthroughComponent, MarbleDiagramComponent, HighlightJsDirective, - SafeUrlPipe + SafeUrlPipe, + ArgumentPipe ], imports: [ CommonModule, diff --git a/src/app/operators/pipes/argument.pipe.ts b/src/app/operators/pipes/argument.pipe.ts new file mode 100644 index 00000000..e9a40201 --- /dev/null +++ b/src/app/operators/pipes/argument.pipe.ts @@ -0,0 +1,15 @@ +import { OperatorParameters } from './../../../operator-docs/operator.model'; +import { Pipe, PipeTransform } from '@angular/core'; + +@Pipe({ name: 'argument' }) +export class ArgumentPipe implements PipeTransform { + transform(argument: OperatorParameters) { + if (argument.attribute) { + return `[${argument.attribute}] + ${argument.description} + `; + } + + return argument.description; + } +} diff --git a/src/operator-docs/combination/combineAll.ts b/src/operator-docs/combination/combineAll.ts index 2fa19355..aa9ddb75 100644 --- a/src/operator-docs/combination/combineAll.ts +++ b/src/operator-docs/combination/combineAll.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const combineAll: OperatorDoc = { name: 'combineAll', operatorType: 'combination', + returnValue: 'Observable', signature: 'public combineAll(project: function): Observable', parameters: [ { diff --git a/src/operator-docs/combination/combineLatest.ts b/src/operator-docs/combination/combineLatest.ts index cb447072..31e06789 100644 --- a/src/operator-docs/combination/combineLatest.ts +++ b/src/operator-docs/combination/combineLatest.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const combineLatest: OperatorDoc = { name: 'combineLatest', operatorType: 'combination', + returnValue: 'Observable', signature: 'public combineLatest(observables: ...Observable, project: function): Observable', useInteractiveMarbles: true, diff --git a/src/operator-docs/combination/concat.ts b/src/operator-docs/combination/concat.ts index ab9c3e6c..18dd7a21 100644 --- a/src/operator-docs/combination/concat.ts +++ b/src/operator-docs/combination/concat.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const concat: OperatorDoc = { name: 'concat', operatorType: 'combination', + returnValue: 'Observable', signature: 'public static concat(input1: ObservableInput, input2: ObservableInput, scheduler: Scheduler): Observable', parameters: [ diff --git a/src/operator-docs/combination/concatAll.ts b/src/operator-docs/combination/concatAll.ts index 906e8458..15b4195a 100644 --- a/src/operator-docs/combination/concatAll.ts +++ b/src/operator-docs/combination/concatAll.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const concatAll: OperatorDoc = { name: 'concatAll', operatorType: 'combination', + returnValue: 'Observable', signature: 'public concatAll(): Observable', parameters: [], marbleUrl: 'http://reactivex.io/rxjs/img/concatAll.png', diff --git a/src/operator-docs/combination/forkJoin.ts b/src/operator-docs/combination/forkJoin.ts index 2b9d891e..b464a642 100644 --- a/src/operator-docs/combination/forkJoin.ts +++ b/src/operator-docs/combination/forkJoin.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const forkJoin: OperatorDoc = { name: 'forkJoin', operatorType: 'combination', + returnValue: 'any', signature: 'public static forkJoin(sources: *): any', parameters: [ { diff --git a/src/operator-docs/combination/merge.ts b/src/operator-docs/combination/merge.ts index ff4d621c..8fb14745 100644 --- a/src/operator-docs/combination/merge.ts +++ b/src/operator-docs/combination/merge.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const merge: OperatorDoc = { name: 'merge', operatorType: 'combination', + returnValue: 'Observable', signature: 'public merge(other: ObservableInput, concurrent: number, scheduler: Scheduler): Observable', parameters: [ diff --git a/src/operator-docs/combination/mergeAll.ts b/src/operator-docs/combination/mergeAll.ts index 915bbf69..130f91db 100644 --- a/src/operator-docs/combination/mergeAll.ts +++ b/src/operator-docs/combination/mergeAll.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const mergeAll: OperatorDoc = { name: 'mergeAll', operatorType: 'combination', + returnValue: 'Observable', signature: 'public mergeAll(concurrent: number): Observable', parameters: [ { diff --git a/src/operator-docs/combination/pairwise.ts b/src/operator-docs/combination/pairwise.ts index 52dce8f2..46607ba4 100644 --- a/src/operator-docs/combination/pairwise.ts +++ b/src/operator-docs/combination/pairwise.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const pairwise: OperatorDoc = { name: 'pairwise', operatorType: 'combination', + returnValue: 'Observable<Array<T>>', marbleUrl: 'http://reactivex.io/rxjs/img/pairwise.png', signature: 'public pairwise(): Observable<Array<T>>', shortDescription: { diff --git a/src/operator-docs/combination/startWith.ts b/src/operator-docs/combination/startWith.ts index 3301855a..c7839d97 100644 --- a/src/operator-docs/combination/startWith.ts +++ b/src/operator-docs/combination/startWith.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const startWith: OperatorDoc = { name: 'startWith', operatorType: 'combination', + returnValue: 'Observable', marbleUrl: 'http://reactivex.io/rxjs/img/startWith.png', signature: 'public startWith(values: ...T, scheduler: Scheduler): Observable', shortDescription: { diff --git a/src/operator-docs/combination/withLatestFrom.ts b/src/operator-docs/combination/withLatestFrom.ts index a7573355..0623b738 100644 --- a/src/operator-docs/combination/withLatestFrom.ts +++ b/src/operator-docs/combination/withLatestFrom.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const withLatestFrom: OperatorDoc = { name: 'withLatestFrom', operatorType: 'combination', + returnValue: 'Observable', signature: 'public withLatestFrom(other: ObservableInput, project: Function): Observable', marbleUrl: 'http://reactivex.io/rxjs/img/withLatestFrom.png', diff --git a/src/operator-docs/creation/empty.ts b/src/operator-docs/creation/empty.ts index 9eb85c8f..e8bbe598 100644 --- a/src/operator-docs/creation/empty.ts +++ b/src/operator-docs/creation/empty.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const empty: OperatorDoc = { name: 'empty', operatorType: 'creation', + returnValue: 'Observable', signature: 'public empty(scheduler?: IScheduler): Observable', parameters: [ { diff --git a/src/operator-docs/creation/from.ts b/src/operator-docs/creation/from.ts index 78b15b7f..6edbfb7f 100644 --- a/src/operator-docs/creation/from.ts +++ b/src/operator-docs/creation/from.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const from: OperatorDoc = { name: 'from', operatorType: 'creation', + returnValue: 'Observable', signature: `from(ish: ArrayLike | ObservableInput, scheduler: Scheduler): Observable`, parameters: [ { diff --git a/src/operator-docs/filtering/debounce.ts b/src/operator-docs/filtering/debounce.ts index e38c568b..a6e4ff12 100644 --- a/src/operator-docs/filtering/debounce.ts +++ b/src/operator-docs/filtering/debounce.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const debounce: OperatorDoc = { name: 'debounce', operatorType: 'filtering', + returnValue: 'Observable', signature: 'public debounce(durationSelector: function(value: T): SubscribableOrPromise): Observable', marbleUrl: 'http://reactivex.io/rxjs/img/debounce.png', diff --git a/src/operator-docs/filtering/debounceTime.ts b/src/operator-docs/filtering/debounceTime.ts index 2a122874..a6add32c 100644 --- a/src/operator-docs/filtering/debounceTime.ts +++ b/src/operator-docs/filtering/debounceTime.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const debounceTime: OperatorDoc = { name: 'debounceTime', operatorType: 'filtering', + returnValue: 'Observable', signature: 'public debounceTime(dueTime: number, scheduler: IScheduler = async): Observable', parameters: [ diff --git a/src/operator-docs/filtering/distinctUntilChanged.ts b/src/operator-docs/filtering/distinctUntilChanged.ts index 7455228b..59ec5a66 100644 --- a/src/operator-docs/filtering/distinctUntilChanged.ts +++ b/src/operator-docs/filtering/distinctUntilChanged.ts @@ -6,6 +6,7 @@ import { OperatorDoc } from '../operator.model'; export const distinctUntilChanged: OperatorDoc = { name: 'distinctUntilChanged', operatorType: 'filtering', + returnValue: 'Observable', signature: 'public distinctUntilChanged(compare: function): Observable', useInteractiveMarbles: true, parameters: [ diff --git a/src/operator-docs/filtering/filter.ts b/src/operator-docs/filtering/filter.ts index 321fe11d..77582250 100644 --- a/src/operator-docs/filtering/filter.ts +++ b/src/operator-docs/filtering/filter.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const filter: OperatorDoc = { name: 'filter', operatorType: 'filtering', + returnValue: 'Observable', signature: 'public filter(predicate: function(value: T, index: number): boolean, thisArg: any): Observable', parameters: [ diff --git a/src/operator-docs/filtering/first.ts b/src/operator-docs/filtering/first.ts index 7d73e1c9..3accd992 100644 --- a/src/operator-docs/filtering/first.ts +++ b/src/operator-docs/filtering/first.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const first: OperatorDoc = { name: 'first', operatorType: 'filtering', + returnValue: 'Observable<T | R>', signature: `public first(predicate: function(value: T, index: number, source: Observable<T>): boolean, resultSelector: function(value: T, index: number): R, defaultValue: R): Observable<T | R>`, parameters: [ diff --git a/src/operator-docs/filtering/last.ts b/src/operator-docs/filtering/last.ts index c08a0288..7a3317fa 100644 --- a/src/operator-docs/filtering/last.ts +++ b/src/operator-docs/filtering/last.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const last: OperatorDoc = { name: 'last', operatorType: 'filtering', + returnValue: 'Observable', signature: 'public last(predicate: function): Observable', useInteractiveMarbles: true, parameters: [ diff --git a/src/operator-docs/filtering/sample.ts b/src/operator-docs/filtering/sample.ts index 50c9666e..3a7fb9ec 100644 --- a/src/operator-docs/filtering/sample.ts +++ b/src/operator-docs/filtering/sample.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const sample: OperatorDoc = { name: 'sample', operatorType: 'filtering', + returnValue: 'Observable<T>', signature: `public sample(notifier: Observable<any>): Observable<T>`, parameters: [ { diff --git a/src/operator-docs/filtering/single.ts b/src/operator-docs/filtering/single.ts index 1ba59753..de842da7 100644 --- a/src/operator-docs/filtering/single.ts +++ b/src/operator-docs/filtering/single.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const single: OperatorDoc = { name: 'single', operatorType: 'filtering', + returnValue: 'Observable<T>', signature: 'public single(predicate: Function): Observable<T>', parameters: [ { diff --git a/src/operator-docs/filtering/skip.ts b/src/operator-docs/filtering/skip.ts index 81800b77..e5639f01 100644 --- a/src/operator-docs/filtering/skip.ts +++ b/src/operator-docs/filtering/skip.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const skip: OperatorDoc = { name: 'skip', operatorType: 'filtering', + returnValue: 'Observable', signature: 'public skip(count: Number): Observable', parameters: [ { diff --git a/src/operator-docs/filtering/skipUntil.ts b/src/operator-docs/filtering/skipUntil.ts index 7c732999..9ab63e7f 100644 --- a/src/operator-docs/filtering/skipUntil.ts +++ b/src/operator-docs/filtering/skipUntil.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const skipUntil: OperatorDoc = { name: 'skipUntil', operatorType: 'filtering', + returnValue: 'Observable<T>', signature: 'public skipUntil(notifier: Observable): Observable<T>', parameters: [ { diff --git a/src/operator-docs/filtering/skipWhile.ts b/src/operator-docs/filtering/skipWhile.ts index db9d782f..f2f9385e 100644 --- a/src/operator-docs/filtering/skipWhile.ts +++ b/src/operator-docs/filtering/skipWhile.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const skipWhile: OperatorDoc = { name: 'skipWhile', operatorType: 'filtering', + returnValue: 'Observable', signature: ` public skipWhile(predicate: Function): Observable `, diff --git a/src/operator-docs/filtering/take.ts b/src/operator-docs/filtering/take.ts index e5d38da8..392caa91 100644 --- a/src/operator-docs/filtering/take.ts +++ b/src/operator-docs/filtering/take.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const take: OperatorDoc = { name: 'take', operatorType: 'filtering', + returnValue: 'Observable<T>', signature: 'public take(count: number): Observable<T>', useInteractiveMarbles: true, parameters: [ diff --git a/src/operator-docs/filtering/takeUntil.ts b/src/operator-docs/filtering/takeUntil.ts index dfaae4d5..3ca526b6 100644 --- a/src/operator-docs/filtering/takeUntil.ts +++ b/src/operator-docs/filtering/takeUntil.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const takeUntil: OperatorDoc = { name: 'takeUntil', operatorType: 'filtering', + returnValue: 'Observable<T>', signature: 'public takeUntil(notifier: Observable): Observable<T>', useInteractiveMarbles: true, parameters: [ diff --git a/src/operator-docs/filtering/takeWhile.ts b/src/operator-docs/filtering/takeWhile.ts index 32d0f579..fabfc961 100644 --- a/src/operator-docs/filtering/takeWhile.ts +++ b/src/operator-docs/filtering/takeWhile.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const takeWhile: OperatorDoc = { name: 'takeWhile', operatorType: 'filtering', + returnValue: 'Observable', signature: 'public takeWhile(predicate: function(value: T, index: number): boolean): Observable', parameters: [ diff --git a/src/operator-docs/filtering/throttle.ts b/src/operator-docs/filtering/throttle.ts index 52cd8043..0029e009 100644 --- a/src/operator-docs/filtering/throttle.ts +++ b/src/operator-docs/filtering/throttle.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const throttle: OperatorDoc = { name: 'throttle', operatorType: 'filtering', + returnValue: 'Observable<T>', signature: 'public throttle(durationSelector: function(value: T): SubscribableOrPromise): Observable<T>', parameters: [ diff --git a/src/operator-docs/filtering/throttleTime.ts b/src/operator-docs/filtering/throttleTime.ts index a7821379..65817231 100644 --- a/src/operator-docs/filtering/throttleTime.ts +++ b/src/operator-docs/filtering/throttleTime.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const throttleTime: OperatorDoc = { name: 'throttleTime', operatorType: 'filtering', + returnValue: 'Observable<T>', signature: 'public throttleTime(duration: number, scheduler: Scheduler): Observable<T>', parameters: [ diff --git a/src/operator-docs/operator.model.ts b/src/operator-docs/operator.model.ts index a15ffe36..a5541fe3 100644 --- a/src/operator-docs/operator.model.ts +++ b/src/operator-docs/operator.model.ts @@ -44,6 +44,7 @@ export interface MenuOperator { export interface OperatorDoc { readonly name?: string; + readonly returnValue?: string; readonly operatorType?: OperatorType; readonly signature?: string; readonly useInteractiveMarbles?: boolean; diff --git a/src/operator-docs/transformation/buffer.ts b/src/operator-docs/transformation/buffer.ts index 3f924029..79b00976 100644 --- a/src/operator-docs/transformation/buffer.ts +++ b/src/operator-docs/transformation/buffer.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const buffer: OperatorDoc = { name: 'buffer', operatorType: 'transformation', + returnValue: 'Observable', signature: 'public buffer(closingNotifier: Observable): Observable', useInteractiveMarbles: true, parameters: [ diff --git a/src/operator-docs/transformation/bufferCount.ts b/src/operator-docs/transformation/bufferCount.ts index 5c96af7f..ca567cc5 100644 --- a/src/operator-docs/transformation/bufferCount.ts +++ b/src/operator-docs/transformation/bufferCount.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const bufferCount: OperatorDoc = { name: 'bufferCount', operatorType: 'transformation', + returnValue: 'Observable', signature: ` bufferCount(bufferSize: number, startBufferEvery: number): Observable`, parameters: [ { diff --git a/src/operator-docs/transformation/bufferTime.ts b/src/operator-docs/transformation/bufferTime.ts index 99622a41..f35476c7 100644 --- a/src/operator-docs/transformation/bufferTime.ts +++ b/src/operator-docs/transformation/bufferTime.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const bufferTime: OperatorDoc = { name: 'bufferTime', operatorType: 'transformation', + returnValue: 'Observable', signature: `bufferTime( bufferTimeSpan: number, bufferCreationInterval: number, diff --git a/src/operator-docs/transformation/bufferToggle.ts b/src/operator-docs/transformation/bufferToggle.ts index 844b8fd2..8549d78e 100644 --- a/src/operator-docs/transformation/bufferToggle.ts +++ b/src/operator-docs/transformation/bufferToggle.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const bufferToggle: OperatorDoc = { name: 'bufferToggle', operatorType: 'transformation', + returnValue: 'Observable', signature: `bufferToggle( openings: SubscribableOrPromise, closingSelector: (value) => SubscribableOrPromise): Observable`, diff --git a/src/operator-docs/transformation/bufferWhen.ts b/src/operator-docs/transformation/bufferWhen.ts index 6f95203b..30aaab18 100644 --- a/src/operator-docs/transformation/bufferWhen.ts +++ b/src/operator-docs/transformation/bufferWhen.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const bufferWhen: OperatorDoc = { name: 'bufferWhen', operatorType: 'transformation', + returnValue: 'Observable', signature: `bufferWhen(closingSelector: () => Observable): Observable`, parameters: [ { diff --git a/src/operator-docs/transformation/groupBy.ts b/src/operator-docs/transformation/groupBy.ts index 9d3da57b..677dc823 100644 --- a/src/operator-docs/transformation/groupBy.ts +++ b/src/operator-docs/transformation/groupBy.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const groupBy: OperatorDoc = { name: 'groupBy', operatorType: 'transformation', + returnValue: 'OperatorFunction<T, GroupedObservable<K, R>>', signature: ` public groupBy(keySelector: (value: T) => K, elementSelector?: ((value: T) => R) | void, diff --git a/src/operator-docs/transformation/map.ts b/src/operator-docs/transformation/map.ts index 9a5c06dd..1cff0fa0 100644 --- a/src/operator-docs/transformation/map.ts +++ b/src/operator-docs/transformation/map.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const map: OperatorDoc = { name: 'map', operatorType: 'transformation', + returnValue: 'Observable', signature: 'public map(project: Function, thisArg: any): Observable', parameters: [ { diff --git a/src/operator-docs/transformation/mergeMap.ts b/src/operator-docs/transformation/mergeMap.ts index 541cd403..c630c9e7 100644 --- a/src/operator-docs/transformation/mergeMap.ts +++ b/src/operator-docs/transformation/mergeMap.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const mergeMap: OperatorDoc = { name: 'mergeMap', operatorType: 'transformation', + returnValue: 'Observable', signature: 'public mergeMap(project: Function, resultSelector?: Function, concurrent?: number): Observable', useInteractiveMarbles: true, diff --git a/src/operator-docs/transformation/partition.ts b/src/operator-docs/transformation/partition.ts index 7ba00fed..cd47908e 100644 --- a/src/operator-docs/transformation/partition.ts +++ b/src/operator-docs/transformation/partition.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const partition: OperatorDoc = { name: 'partition', operatorType: 'transformation', + returnValue: '[Observable<T>, Observable<T>]', signature: 'public partition(predicate: function(value: T, index: number): boolean, thisArg: any): [Observable<T>, Observable<T>]', marbleUrl: 'http://reactivex.io/rxjs/img/partition.png', diff --git a/src/operator-docs/transformation/pluck.ts b/src/operator-docs/transformation/pluck.ts index c26f0d26..42bed702 100644 --- a/src/operator-docs/transformation/pluck.ts +++ b/src/operator-docs/transformation/pluck.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const pluck: OperatorDoc = { name: 'pluck', operatorType: 'transformation', + returnValue: 'Observable', signature: 'public pluck(properties: ...string): Observable', marbleUrl: 'http://reactivex.io/rxjs/img/pluck.png', parameters: [ diff --git a/src/operator-docs/transformation/scan.ts b/src/operator-docs/transformation/scan.ts index 663ad243..b7d19f71 100644 --- a/src/operator-docs/transformation/scan.ts +++ b/src/operator-docs/transformation/scan.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const scan: OperatorDoc = { name: 'scan', operatorType: 'transformation', + returnValue: 'Observable', signature: 'public scan(accumulator: Function, seed: any): Observable', parameters: [ { diff --git a/src/operator-docs/transformation/switchMap.ts b/src/operator-docs/transformation/switchMap.ts index 31d3c52c..8e70f17f 100644 --- a/src/operator-docs/transformation/switchMap.ts +++ b/src/operator-docs/transformation/switchMap.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const switchMap: OperatorDoc = { name: 'switchMap', operatorType: 'transformation', + returnValue: 'Observable', signature: `switchMap(project: (value: T, index: number) => ObservableInput<I>, resultSelector: (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number) => R): Observable`, parameters: [ diff --git a/src/operator-docs/transformation/window.ts b/src/operator-docs/transformation/window.ts index 66748cb7..da3f2cb0 100644 --- a/src/operator-docs/transformation/window.ts +++ b/src/operator-docs/transformation/window.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const windowOperator: OperatorDoc = { name: 'window', operatorType: 'transformation', + returnValue: 'Observable<Observable<T>>', signature: 'public window(windowBoundaries: Observable<any>): Observable<Observable<T>>', parameters: [ diff --git a/src/operator-docs/utility/delay.ts b/src/operator-docs/utility/delay.ts index f7a22c49..e4265b77 100644 --- a/src/operator-docs/utility/delay.ts +++ b/src/operator-docs/utility/delay.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const delay: OperatorDoc = { name: 'delay', operatorType: 'utility', + returnValue: 'Observable', signature: 'public delay(delay: number | Date, scheduler: Scheduler): Observable', parameters: [ diff --git a/src/operator-docs/utility/do.ts b/src/operator-docs/utility/do.ts index d5606a17..7cc67ae8 100644 --- a/src/operator-docs/utility/do.ts +++ b/src/operator-docs/utility/do.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const doOperator: OperatorDoc = { name: 'do', operatorType: 'utility', + returnValue: 'Observable', signature: 'public do(nextOrObserver: Observer | function, error: function, complete: function): Observable', parameters: [ diff --git a/src/operator-docs/utility/let.ts b/src/operator-docs/utility/let.ts index a6a952ba..75bdeef2 100644 --- a/src/operator-docs/utility/let.ts +++ b/src/operator-docs/utility/let.ts @@ -3,6 +3,7 @@ import { OperatorDoc } from '../operator.model'; export const letOperator: OperatorDoc = { name: 'let', operatorType: 'utility', + returnValue: 'Observable', signature: 'public let(fun: function): Observable,', parameters: [ {