Vikasg7 / line-reader

NodeJs *Generator function to read a file line by line

line-reader

• Intro

  line-reader is a ES6 Generator function which returns an iterable to iterater over lines in a file or stdin one by one using .next() method or for..of loop.

• Install

  npm install git+https://github.com/Vikasg7/line-reader.git

• Usage (in TypeScript)

  import { LineReader } from "line-reader"
  
  // FromLine and ToLine are optional arguments
  const filePathOrStdin = "path-to-file.txt" || process.stdin
  const FromLine: number = 1 // default is 0
  const ToLine: number = 5 // default is Infinity
  const chunkSizeInBytes = 8 * 1024 // default is 64 * 1024
  
  const list: IterableIterator<string> = LineReader(filePathOrStdin, FromLine, ToLine, chunkSizeInBytes)
  
  // Call list.next to iterate over lines in a file
  list.next()
  
  // Iterating using a for..of loop
  for (const item of list) {
     console.log(item)
  }

• Example

  Check the tests folder in src folder for an example.