From f6508d784ed1a1896773c6ff162d7f7958b6f933 Mon Sep 17 00:00:00 2001 From: "Wortmann, Jan-Niklas" Date: Tue, 13 Feb 2018 18:11:21 +0100 Subject: [PATCH 1/2] docs(operators): add documentation for of --- src/operator-docs/creation/of.ts | 67 +++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 2 deletions(-) diff --git a/src/operator-docs/creation/of.ts b/src/operator-docs/creation/of.ts index 083be9c6..bfe32848 100644 --- a/src/operator-docs/creation/of.ts +++ b/src/operator-docs/creation/of.ts @@ -1,6 +1,69 @@ import { OperatorDoc } from '../operator.model'; export const ofOperator: OperatorDoc = { - 'name': 'of', - 'operatorType': 'creation' + name: 'of', + operatorType: 'creation', + signature: 'public of(values: ...T, scheduler: IScheduler ): Observable', + parameters: [ + { + name: 'args', + type: 'T', + description: 'Arguments that represent next values to be emitted.', + attribute: '' + }, + { + name: 'scheduler', + type: 'IScheduler', + description: + 'A IScheduler to use for scheduling the emissions of the next notifications.', + attribute: 'optional' + } + ], + relatedOperators: ['create', 'empty', 'never', 'throw'], + marbleUrl: 'http://reactivex.io/rxjs/img/of.png', + shortDescription: { + description: `Creates an Observable that emits some values you specify as arguments, + immediately one after the other, and then emits a complete notification.` + }, + walkthrough: { + description: ` +

+ This static operator is useful for creating a simple Observable that only emits the arguments given, + and the complete notification thereafter. It can be used for composing with other Observables, + such as with concat. By default, it uses a null IScheduler, which means the next notifications + are sent synchronously, although with a different IScheduler it is possible to determine + when those notifications will be delivered.

+ ` + }, + examples: [ + { + name: `Emit 10, 20, 30, then 'a', 'b', 'c', then start ticking every second.`, + code: ` + import { of } from 'rxjs/observable/of'; + import { interval } from 'rxjs/observable/interval'; + import { concat } from 'rxjs/operators'; + + const numbers = of(10, 20, 30); + const letters = of('a', 'b', 'c'); + const interval = interval(1000); + const result = numbers.pipe( + concat(letters), + concat(interval)); + result.subscribe(x => console.log(x));`, + // 10 + // 20 + // 30 + // 'a' + // 'b' + // 'c' + // 0 + // 1 + // 2 + // ... + externalLink: { + platform: 'JSBin', + url: 'http://jsbin.com/porolatazu/embed?js,output' + } + } + ] }; From 733e57efc601ed49ccbb8ba6de53cca75ae32856 Mon Sep 17 00:00:00 2001 From: "Wortmann, Jan-Niklas" Date: Mon, 26 Feb 2018 12:43:02 +0100 Subject: [PATCH 2/2] docs(operators): fix naming conflict and combine concats --- src/operator-docs/creation/of.ts | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/operator-docs/creation/of.ts b/src/operator-docs/creation/of.ts index bfe32848..530e9103 100644 --- a/src/operator-docs/creation/of.ts +++ b/src/operator-docs/creation/of.ts @@ -45,10 +45,9 @@ export const ofOperator: OperatorDoc = { const numbers = of(10, 20, 30); const letters = of('a', 'b', 'c'); - const interval = interval(1000); + const interval$ = interval(1000); const result = numbers.pipe( - concat(letters), - concat(interval)); + concat(letters, interval$), result.subscribe(x => console.log(x));`, // 10 // 20 @@ -62,7 +61,7 @@ export const ofOperator: OperatorDoc = { // ... externalLink: { platform: 'JSBin', - url: 'http://jsbin.com/porolatazu/embed?js,output' + url: 'http://jsbin.com/hiquyaluqa/1/embed?js,console' } } ]