Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(single): Added see also links #4693

Merged
merged 2 commits into from Apr 23, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/internal/operators/repeatWhen.ts
Expand Up @@ -18,6 +18,22 @@ import { MonoTypeOperatorFunction, TeardownLogic } from '../types';
*
* ![](repeatWhen.png)
*
* ## Example
* Repeat a message stream on click
* ```ts
* import { of, fromEvent } from 'rxjs';
* import { repeatWhen } from 'rxjs/operators';
*
* const source = of('Repeat message');
* const documentClick$ = fromEvent(document, 'click');
*
* source.pipe(repeatWhen(() => documentClick$)
* ).subscribe(data => console.log(data))
* ```
* @see {@link repeat}
* @see {@link retry}
* @see {@link retryWhen}
*
* @param {function(notifications: Observable): Observable} notifier - Receives an Observable of notifications with
* which a user can `complete` or `error`, aborting the repetition.
* @return {Observable} The source Observable modified with repeat logic.
Expand Down
3 changes: 3 additions & 0 deletions src/internal/operators/single.ts
Expand Up @@ -38,6 +38,9 @@ import { Observer, MonoTypeOperatorFunction, TeardownLogic } from '../types';
* ```
*
* @see {@link first}
* @see {@link find}
* @see {@link findIndex}
* @see {@link elementAt}
*
* @throws {EmptyError} Delivers an EmptyError to the Observer's `error`
* callback if the Observable completes before any `next` notification was sent.
Expand Down