bufferCount.js 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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 the size hits the maximum
  6. * `bufferSize` given.
  7. *
  8. * <span class="informal">Collects values from the past as an array, and emits
  9. * that array only when its size reaches `bufferSize`.</span>
  10. *
  11. * <img src="./img/bufferCount.png" width="100%">
  12. *
  13. * Buffers a number of values from the source Observable by `bufferSize` then
  14. * emits the buffer and clears it, and starts a new buffer each
  15. * `startBufferEvery` values. If `startBufferEvery` is not provided or is
  16. * `null`, then new buffers are started immediately at the start of the source
  17. * and when each buffer closes and is emitted.
  18. *
  19. * @example <caption>Emit the last two click events as an array</caption>
  20. * var clicks = Rx.Observable.fromEvent(document, 'click');
  21. * var buffered = clicks.bufferCount(2);
  22. * buffered.subscribe(x => console.log(x));
  23. *
  24. * @example <caption>On every click, emit the last two click events as an array</caption>
  25. * var clicks = Rx.Observable.fromEvent(document, 'click');
  26. * var buffered = clicks.bufferCount(2, 1);
  27. * buffered.subscribe(x => console.log(x));
  28. *
  29. * @see {@link buffer}
  30. * @see {@link bufferTime}
  31. * @see {@link bufferToggle}
  32. * @see {@link bufferWhen}
  33. * @see {@link pairwise}
  34. * @see {@link windowCount}
  35. *
  36. * @param {number} bufferSize The maximum size of the buffer emitted.
  37. * @param {number} [startBufferEvery] Interval at which to start a new buffer.
  38. * For example if `startBufferEvery` is `2`, then a new buffer will be started
  39. * on every other value from the source. A new buffer is started at the
  40. * beginning of the source by default.
  41. * @return {Observable<T[]>} An Observable of arrays of buffered values.
  42. * @method bufferCount
  43. * @owner Observable
  44. */
  45. function bufferCount(bufferSize, startBufferEvery) {
  46. if (startBufferEvery === void 0) { startBufferEvery = null; }
  47. return operators_1.bufferCount(bufferSize, startBufferEvery)(this);
  48. }
  49. exports.bufferCount = bufferCount;
  50. //# sourceMappingURL=bufferCount.js.map