37 lines
1.1 KiB
TypeScript
37 lines
1.1 KiB
TypeScript
|
import { Observable } from '../Observable';
|
||
|
|
/**
|
||
|
|
* An Observable that emits no items to the Observer and never completes.
|
||
|
|
*
|
||
|
|
* 
|
||
|
|
*
|
||
|
|
* A simple Observable that emits neither values nor errors nor the completion
|
||
|
|
* notification. It can be used for testing purposes or for composing with other
|
||
|
|
* Observables. Please note that by never emitting a complete notification, this
|
||
|
|
* Observable keeps the subscription from being disposed automatically.
|
||
|
|
* Subscriptions need to be manually disposed.
|
||
|
|
*
|
||
|
|
* ## Example
|
||
|
|
* ### Emit the number 7, then never emit anything else (not even complete)
|
||
|
|
* ```ts
|
||
|
|
* import { NEVER } from 'rxjs';
|
||
|
|
* import { startWith } from 'rxjs/operators';
|
||
|
|
*
|
||
|
|
* function info() {
|
||
|
|
* console.log('Will not be called');
|
||
|
|
* }
|
||
|
|
* const result = NEVER.pipe(startWith(7));
|
||
|
|
* result.subscribe(x => console.log(x), info, info);
|
||
|
|
*
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @see {@link Observable}
|
||
|
|
* @see {@link index/EMPTY}
|
||
|
|
* @see {@link of}
|
||
|
|
* @see {@link throwError}
|
||
|
|
*/
|
||
|
|
export declare const NEVER: Observable<never>;
|
||
|
|
/**
|
||
|
|
* @deprecated Deprecated in favor of using {@link NEVER} constant.
|
||
|
|
*/
|
||
|
|
export declare function never(): Observable<never>;
|