README

level-blocked

key design

'<key>\xffblocks\xff<block index>'

api

var blocks = blocked(db, [blockSize])

db: A LevelUp database.
blockSize: Each block's maximum size in bytes, defaults to 1024.

var level = require('level');
var blocked = require('level-blocked');

var db = level(__dirname + '/db');
var blocks = blocked(db, 3);

blocks.createReadStream(key[, opts])

Streaming read access.

key: The address of your data
opts.start: The first byte to read
opts.end: The last byte to read

blocks.createReadStream('key').on('data', function(block) {
  console.log('block: %s', block);
  // => block: val
  // => block: ue
});

blocks.read(key[, opts], cb)

Callback / buffered read access.

key: The address of your data
opts.start: The first byte to read
opts.end: The last byte to read

blocks.read('key', function(err, block) {
  if (err) throw err;
  console.log('block: %s', block);
  // => block: value
});

block.createWriteStream(key[, opts])

Streaming write access.

key: The address of your data
opts.start: Writer after this byte
opts.batch: Write to this batch

blocks.createWriteStream('key').end('value');

blocks.write(key[, opts], cb)

Callback write access.

key: The address of your data
opts.start: Writer after this byte
opts.batch: Write to this batch

blocks.write('key', 'value', function(err){
  if (err) throw err;
});

installation

With npm do:

npm install level-blocked

license

(MIT)

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.

Usage no npm install needed!