.config/coc/extensions/node_modules/coc-prettier/node_modules/rxjs/src/internal/observable/never.ts

   1 import { Observable } from '../Observable';
   2 import { noop } from '../util/noop';
   3
   4 /**
   5  * An Observable that emits no items to the Observer and never completes.
   6  *
   7  * ![](never.png)
   8  *
   9  * A simple Observable that emits neither values nor errors nor the completion
  10  * notification. It can be used for testing purposes or for composing with other
  11  * Observables. Please note that by never emitting a complete notification, this
  12  * Observable keeps the subscription from being disposed automatically.
  13  * Subscriptions need to be manually disposed.
  14  *
  15  * ##  Example
  16  * ### Emit the number 7, then never emit anything else (not even complete)
  17  * ```ts
  18  * import { NEVER } from 'rxjs';
  19  * import { startWith } from 'rxjs/operators';
  20  *
  21  * function info() {
  22  *   console.log('Will not be called');
  23  * }
  24  * const result = NEVER.pipe(startWith(7));
  25  * result.subscribe(x => console.log(x), info, info);
  26  *
  27  * ```
  28  *
  29  * @see {@link Observable}
  30  * @see {@link index/EMPTY}
  31  * @see {@link of}
  32  * @see {@link throwError}
  33  */
  34 export const NEVER = new Observable<never>(noop);
  35
  36 /**
  37  * @deprecated Deprecated in favor of using {@link NEVER} constant.
  38  */
  39 export function never () {
  40   return NEVER;
  41 }