JSPM

pull-buffer-until

2.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q36133F
  • License MIT

group incoming items until either max item count is reached or no new items arrived for a while (like pull-group but with a timeout)

Package Exports

  • pull-buffer-until

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pull-buffer-until) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

pull-buffer-until

NPM

Group incoming items until either a condition is met or no new items arrived for a while. This is great for processing data in batches while still retaining realtime-ness. Like pull-group, but with a timeout, and like pull-debounce, but with collecting intermediate items.

Example

const pull = require('pull-stream')
const bufferUntil = require('pull-buffer-unril')

function timedSource(data) {
  return pull(
    pull.values(data),
    pull.asyncMap(function(item, cb) {
      setTimeout(function() {
        cb(null, item[1])
      }, item[0])
    })
  )
}
pull(
  timedSource([
    [10,  5],
    [10,  6],
    [10,  7],
    [10,  8],
    [10,  9],
    [10, 10],
    [10, 11],
    [50, 15],
    [10, 16],
    [10, 17],
    [10, 18],
    [10, 19],
    [10, 20],
  ]),
  bufferUntil(buffer => buffer.length == 3, {timeout: 40}),
  pull.log()
)
/* => 
[5,6,7]
[8,9,10]
[11]
[15,16,17]
[18,19,20]

API

bufferUntil([condition], [opts])

  • condition is called with the array of bufered items. If it returns a truthy value, the buffer is flushed (emitted downstream).
  • opts
    • timeout: If no new items arrive within the specified number of milliseconds, the buffer is flushed.

License

MIT