Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Binary and event-based data buffered readers.
JavaScript
tree: e1db729ec8

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
build
examples
src
test
.gitignore
LICENSE
README.md

README.md

Node BufferedReader

Fully configurable buffered reader for node.js

Show me! | Availability | Compatibility | Documentation

Version: 0.2.7

When you need to read a file you typically read a chunk of bytes called "buffer" to avoid multiple calls to the underlying I/O layer, so instead of reading directly from the disk, you read from the previous filled buffer. Doing this you win performance.

This library allows you to read files using internal buffers, so you don't have to worry about them. In addition, you can read a text file line by line.

Show me!

var BufferedReader = require ("buffered-reader");

var offset;

new BufferedReader ("file", { encoding: "utf8" })
    .on ("error", function (error){
        console.log (error);
    })
    .on ("line", function (line, byteOffset){
        if (line === "Phasellus ultrices ligula sed odio ultricies egestas."){
            offset = byteOffset;
            this.interrupt ();
        }
    })
    .on ("end", function (){
        this.seek (offset, function (error){
            if (error) return console.log (error);

            this.readBytes (9, function (error, bytes, bytesRead){
                if (error) return console.log (error);

                console.log (bytes.toString ()); //Prints: Curabitur

                this.close (function (error){
                    if (error) console.log (error);
                });
            });
        });
    })
    .read ();

file:

Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Morbi convallis nibh massa, eu varius felis.

Phasellus ultrices ligula sed odio ultricies egestas.
Curabitur pretium magna in diam accumsan dignissim.
Phasellus et tortor eu orci suscipit vehicula.
Phasellus pulvinar mauris in purus consequat vel congue orci hendrerit.
Pellentesque eget arcu magna, suscipit imperdiet eros.

Availability

Via npm:

npm install buffered-reader

Compatibility

✔ Node *


Documentation

Reference
Examples
Change Log
MIT License

Something went wrong with that request. Please try again.