buffer.js 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. var operators_1 = require("rxjs/operators");
  4. /**
  5. * Buffers the source Observable values until `closingNotifier` emits.
  6. *
  7. * <span class="informal">Collects values from the past as an array, and emits
  8. * that array only when another Observable emits.</span>
  9. *
  10. * <img src="./img/buffer.png" width="100%">
  11. *
  12. * Buffers the incoming Observable values until the given `closingNotifier`
  13. * Observable emits a value, at which point it emits the buffer on the output
  14. * Observable and starts a new buffer internally, awaiting the next time
  15. * `closingNotifier` emits.
  16. *
  17. * @example <caption>On every click, emit array of most recent interval events</caption>
  18. * var clicks = Rx.Observable.fromEvent(document, 'click');
  19. * var interval = Rx.Observable.interval(1000);
  20. * var buffered = interval.buffer(clicks);
  21. * buffered.subscribe(x => console.log(x));
  22. *
  23. * @see {@link bufferCount}
  24. * @see {@link bufferTime}
  25. * @see {@link bufferToggle}
  26. * @see {@link bufferWhen}
  27. * @see {@link window}
  28. *
  29. * @param {Observable<any>} closingNotifier An Observable that signals the
  30. * buffer to be emitted on the output Observable.
  31. * @return {Observable<T[]>} An Observable of buffers, which are arrays of
  32. * values.
  33. * @method buffer
  34. * @owner Observable
  35. */
  36. function buffer(closingNotifier) {
  37. return operators_1.buffer(closingNotifier)(this);
  38. }
  39. exports.buffer = buffer;
  40. //# sourceMappingURL=buffer.js.map