Skip to content
Async generator functions which return records read from a stream, string or text file using a custom record separator.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests
README.md
index.js
package-lock.json
package.json

README.md

read-record

Async generator functions which return records read from a stream, string or text file using a custom record separator.

In Perl or Awk, by default, files are read line by line, because \n is used as the record or input field separator. If you want to change this (to read records separated, for example, by ';' you can chage $/ (in Perl) or RS (in Awk) to ';'.

Node.js readline module documentation explains how to use a for await...of loop to read lines from a file. But what if it is not lines you want to read?

Install

npm i -S read-record
const rr = require('read-record');

Try it in your browser

API

  • rr.records(stream, recsep)

    • stream is a Readable Stream
    • recsep is either a String or Regular Expression (anything that can be passed on to String.split() method)
  • rr.recordsFromFile(path, recsep)

    • path is a String containing a valid path to a text file.
  • rr.recordsFromString(str, recsep)

    • str is a String.

Example

const rr = require('read-record');

const records = rr.recordsFromString('This is a string', ' ');

for await (const rec of records){
  console.log(rec);
}

// This
// is
// a
// string

To do

  • add option to discard empty records
  • add option to define size of fs.createReadStream highWaterMark
  • add option to define size of fs.createReadStream encoding param
  • evalutate (and increase) efficiency
  • use event 'line' instead of for await...of loop
  • use indexOf instead of regular expressions?

Bugs and stuff

Open a GitHub issue or, preferably, send me a pull request.

License

The MIT License (MIT)

Copyright (c) 2019 André Santos andrefs@andrefs.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.