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

browser-line-reader

v0.3.1

Published

A line by line async file reader for the browser

Downloads

259

Readme

browser-line-reader

An asynchronous line by line file reader for the browser.

This project addresses the lack of asynchronous, promise aware, typescript based file reader solutions specifically crafted for the browser.

This module reads a File object, using the standard FileReader, one line at a time. In order to achieve this, the file is subject to multiple reads, in 'chunks', which can contain any number of lines.

The advantage of this method is that there is no need for the entire file to be stored in browser memory, and lines can be processed and then discarded. This is especially useful when reading in large files spanning many hundreds of megabytes.

Installation

npm install browser-line-reader --save

Usage

The following types are used in the type signatures below:

interface Options {
	encoding?: string;
}

type LineReaderCallback = (line: string) => void;

To get started, import the LineReader class as a default export.

import LineReader from 'browser-line-reader';

constructor

Type: (file: File) => LineReader

The LineReader class constructor accepting the File object to read.

const myFile: File = new File(['My name is...'], 'SlimShady');
const lineReader: LineReader = new LineReader(myFile);

readLines

Type: (callback?: LineReaderCallback) => Promise<number>

Read all the lines of a file, one by one. Accepts a callback with one parameter of type string, which is the line just read. Returns a promise containing the total number of lines read. Throws an error passed through from the internal FileReader.prototype.onerror event.

lineReader.readLines((line: string) => {
	console.log(line);
}).then((numLinesRead: number) => {
	console.log(`Finished and read ${numLinesRead} lines`);
}).catch((err) => {
	console.log(err);
});

readNLines

Type: (nLines: number, callback?: LineReaderCallback) => Promise<number>

Read the first n lines of a file of k lines, or all lines if n > k or n < 0. Return and exceptions are identical to Linereader.prototype.readLines.

lineReader.readNLines(10, (line: string) => {
	console.log(line);
});

Missing Features

  • Support for different kinds of line separators
  • Support for separate read header action
  • Efficiency optimisations
  • Benchmarking against standard FileReader API
  • Add contributing guidelines

Please suggest or implement these or any other features you feel are missing.