pull-offset-limit

1.1.1 • Public • Published

pull-offset-limit

npm version build status test coverage downloads js-standard-style

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

License

MIT

Package Sidebar

Install

npm i pull-offset-limit

Weekly Downloads

1,212

Version

1.1.1

License

MIT

Last publish

Collaborators

  • jdvorak