repeatWhen

Returns an Observable that mirrors the source Observable with the exception of a complete. If the source Observable calls complete, this method will emit to the Observable returned from notifier. If that Observable calls complete or error, then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Deprecation Notes

Will be removed in v9 or v10. Use repeat's delay option instead.

repeatWhen<T>(notifier: (notifications: Observable<void>) => Observable<any>): MonoTypeOperatorFunction<T>

Parameters

notifier

(notifications: Observable<void>) => Observable<any>

Receives an Observable of notifications with which a user can complete or error, aborting the repetition.

Returns

MonoTypeOperatorFunction<T>: A function that returns an Observable that that mirrors the source Observable with the exception of a complete.

Description

Example

Repeat a message stream on click

import { of, fromEvent, repeatWhen } from 'rxjs';

const source = of('Repeat message');
const documentClick$ = fromEvent(document, 'click');

const result = source.pipe(repeatWhen(() => documentClick$));

result.subscribe(data => console.log(data))

See Also

• repeat
• retry
• retryWhen