npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

line-reader-plus

v0.1.0

Published

Read text files with stream pipes and parse into lines with start/end byte position and row number.

Downloads

4

Readme

Line Reader Plus - know where your lines are located.

Processes stream chunks into lines using a separator and adds extra info: start/end byte position and row number. Very useful if after reading the lines you want to modify them.

Install

npm install line-reader-plus

Basic Usage

const fs = require("fs")
const LineReaderPlus = require("line-reader-plus")  

fs.createReadStream("pathToYourFile")
    .pipe(new LineReaderPlus())
    .on("data", (line) => {
        // line = {value: String, start: Int, end: Int, row: Int)            
    })

Custom Options

const fs = require("fs")
const LineReaderPlus = require("line-reader-plus")  

fs.createReadStream("pathToYourFile")
    .pipe(new LineReaderPlus("SeparateMe", "ascii", {highWaterMark: 8}))
    .on("data", (line) => {
        // line = {value: String, start: Int, end: Int, row: Int)           
    })

Notes

Option objectMode is always true. Meaning you cannot overwrite it. This is required in order to return objects in streams on("data") event. Otherwise all Transform stream options are acceptable and should work.

Benchmarks

I was curious how much does this processing affect stream performance and was pleasantly surprised:

8192 bytes in HEX x 10000 lines = ~160 MB
  3 tests completed.

With LineReadePlus x 4.50 ops/sec ±5.67% (26 runs sampled)
With Split2        x 2.50 ops/sec ±6.29% (17 runs sampled)*
RAW (no pipes)     x 7.55 ops/sec ±2.74% (40 runs sampled)

*No extra info, just splitting into lines.

What do you know, only ~40% slower than raw and faster than well established split2. But take the results with a grain of salt. There's plenty of OS level caching going on behind the scenes. Which means that speed might be quite off. To check it yourself, run: npm run benchmark

Testing

npm test

Linting

npm run lint