42e93547372022a50e78bc94e7fcd4702a11f7a279ea488ab06e7fc4ae6e143ade0d3950f3aec2980206ba3b761544ed7214b85e85a2cbf16b307131ff8a0e 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. import { Observable } from '../Observable';
  2. import { SubscribableOrPromise, ObservedValueOf, ObservableInput } from '../types';
  3. import { from } from './from'; // lol
  4. import { empty } from './empty';
  5. /**
  6. * Creates an Observable that, on subscribe, calls an Observable factory to
  7. * make an Observable for each new Observer.
  8. *
  9. * <span class="informal">Creates the Observable lazily, that is, only when it
  10. * is subscribed.
  11. * </span>
  12. *
  13. * ![](defer.png)
  14. *
  15. * `defer` allows you to create the Observable only when the Observer
  16. * subscribes, and create a fresh Observable for each Observer. It waits until
  17. * an Observer subscribes to it, and then it generates an Observable,
  18. * typically with an Observable factory function. It does this afresh for each
  19. * subscriber, so although each subscriber may think it is subscribing to the
  20. * same Observable, in fact each subscriber gets its own individual
  21. * Observable.
  22. *
  23. * ## Example
  24. * ### Subscribe to either an Observable of clicks or an Observable of interval, at random
  25. * ```ts
  26. * import { defer, fromEvent, interval } from 'rxjs';
  27. *
  28. * const clicksOrInterval = defer(function () {
  29. * return Math.random() > 0.5
  30. * ? fromEvent(document, 'click')
  31. * : interval(1000);
  32. * });
  33. * clicksOrInterval.subscribe(x => console.log(x));
  34. *
  35. * // Results in the following behavior:
  36. * // If the result of Math.random() is greater than 0.5 it will listen
  37. * // for clicks anywhere on the "document"; when document is clicked it
  38. * // will log a MouseEvent object to the console. If the result is less
  39. * // than 0.5 it will emit ascending numbers, one every second(1000ms).
  40. * ```
  41. *
  42. * @see {@link Observable}
  43. *
  44. * @param {function(): SubscribableOrPromise} observableFactory The Observable
  45. * factory function to invoke for each Observer that subscribes to the output
  46. * Observable. May also return a Promise, which will be converted on the fly
  47. * to an Observable.
  48. * @return {Observable} An Observable whose Observers' subscriptions trigger
  49. * an invocation of the given Observable factory function.
  50. * @static true
  51. * @name defer
  52. * @owner Observable
  53. */
  54. export function defer<R extends ObservableInput<any> | void>(observableFactory: () => R): Observable<ObservedValueOf<R>> {
  55. return new Observable<ObservedValueOf<R>>(subscriber => {
  56. let input: R | void;
  57. try {
  58. input = observableFactory();
  59. } catch (err) {
  60. subscriber.error(err);
  61. return undefined;
  62. }
  63. const source = input ? from(input as ObservableInput<ObservedValueOf<R>>) : empty();
  64. return source.subscribe(subscriber);
  65. });
  66. }