Giter Club home page Giter Club logo

hypercore-multipart's Introduction

hypercore-multipart

Partition bytes into several Hypercore feeds

Installation

$ npm install hypercore-multipart

Example

const multipart = require('hypercore-multipart')
const Corestore = require('corestore')
const fs = require('fs')

const corestore = new Corestore(ram)

fs.open('/path/to/file', (err, fd) => {
  multipart({ read, pageSize: 5 * 1024 * 1024, bufferSize: 4096 }, (err, parts) => {
    // `parts` is an array of hypercores with a byteLength at most `pageSize`
  })

  function read(offset, length, callback) {
    const buffer = Buffer.alloc(length)
    fs.read(fd, buffer, 0, length, offset, (err) => callback(err, buffer))
  }
})

API

state = multipart(opts, callback)

Reads bytes from a source partitioning chunks into Hypercore feeds where calling callback(err, parts) with an error if one occurs or parts, an array of hypercore feeds. opts can be:

{
  bufferSize: 4096, // how big the read buffers should be
  pageSize: 10 * 1024 * 1024, // how big the hypercore feeds should be
  offset: 0, // the initial offset to start reading at

  corestore: null, // a corestore instance for hypercore creation
  masterKey: crypto.randomBytes(32), // the master key for key derivation
  namespace: 'multipart', // the namespace for key derivation

  read: null, // a function that accepts an offset, length, and callback to read bytes from a source
  stat: null, // a function that explicitly resolves the size of the source
  onpage(page, hypercore), // a function that is called upon cycling to a new page (hypercore)
}

state.bufferSize

The read buffer size for the multipart state.

state.pageSize

The size for each page (hypercore feed) for the multipart state.

state.offset

The current read offset for the multipart state.

state.blocks

The number of blocks in the multipart state.

state.page

The current page of the multipart state.

state.stats

Stats (if available) for the multipart state.

state.masterKey

The master key for the multipart state.

License

MIT

hypercore-multipart's People

Contributors

jwerle avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

hypercore-multipart's Issues

interesting idea, what is the use case?

I have a use case for backing up Hypercore to S3 was searching for a solution. Stumbled upon your multipart repo. Could you elaborate on what was the intent behind creating it and how you or others use it today?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.