pull-offset-limit
v1.1.1
Published
A pull-stream that filters until X elements, and stops streaming after Y elements.
Downloads
284
Maintainers
Readme
pull-offset-limit
A pull-stream that filters until X elements, and stops streaming after Y elements. Useful for pagination purposes.
Usage
const pull = require('pull-stream')
const split = require('pull-split')
const offsetLimit = require('pull-offset-limit')
pull(
textStream, // some text stream
split(), // split on new lines
offsetLimit(5, 20), // after 5 lines, take 20
output
)
API
offsetLimit = require('pull-offset-limit')(offset, limit, onLimit)
Create a new offsetLimit through stream.
- offset: if set, filters stream until offset is reached
- limit: if set, stops stream when limit is reached
- onLimit: if set, runs when limit is reached
Installation
$ npm install pull-offset-limit