skipfile v0.1.0

SYNOPSIS

Append data, seek forward and seek backward inside a binary file.

API

CONSTRUCTOR

Using new Skipfile() or Skipfile() will create a new instance. The constructor accepts an options object. { filename: path } specifies the target file to read and write to.

INSTANCE METHODS

append(value, callback)

Appends a value to the file specified in the constructor.

var skip = Skipfile(function(err) {
  skip.append(randomData(), function(err, offset) {
  });
});

forward(bytes, callback)

Seeks forward from bytes.

var skip = Skipfile(function(err) {

  -function forward(pos) {
    skip.forward(pos, function(err, seq, len, offset, val) {
      if (val) forward(offset + 1);
    });
  }(0);
});

backward(bytes, callback)

Seeks backward from bytes.

var skip = Skipfile(function(err) {

  -function backward(pos) {
    skip.backward(pos, function(err, seq, len, offset, val) {
      if (val) backward(offset);
    });
  }(skip.size);
});

close(callback)

Closes the file descriptor opened by the constructor.

skip.close(function(err) {
});

INSTANCE MEMBERS

size

Tracks the size of the file opened by the constructor.