Skip to content

Commit

Permalink
docs(repeat): description change to reflect resubscription (#4587)
Browse files Browse the repository at this point in the history
repeat was described as "repeating source stream items", while actually it resubscribes to it.

closes #4586
  • Loading branch information
kosich authored and niklas-wortmann committed Feb 28, 2019
1 parent 7fc6f5b commit be8bcfd
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/internal/operators/repeat.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ import { empty } from '../observable/empty';
import { MonoTypeOperatorFunction, TeardownLogic } from '../types';

/**
* Returns an Observable that repeats the stream of items emitted by the source Observable at most count times.
* Returns an Observable that will resubscribe to the source stream when the source stream completes, at most count times.
*
* ![](repeat.png)
*
* @param {number} [count] The number of times the source Observable items are repeated, a count of 0 will yield
* an empty Observable.
* @return {Observable} An Observable that repeats the stream of items emitted by the source Observable at most
* count times.
* @return {Observable} An Observable that will resubscribe to the source stream when the source stream completes
* , at most count times.
* @method repeat
* @owner Observable
*/
Expand Down

0 comments on commit be8bcfd

Please sign in to comment.