Giter Site home page Giter Site logo

dat-ecosystem-archive / multidat Goto Github PK

View Code? Open in Web Editor NEW
22.0 10.0 6.0 31 KB

Manage multiple dat instances [ DEPRECATED - More info on active projects and modules at https://dat-ecosystem.org/ ]

License: MIT License

JavaScript 100.00%
dat multiplex manage

multidat's Introduction

deprecated

More info on active projects and modules at dat-ecosystem.org


multidat

npm version build status test coverage downloads js-standard-style

Manage multiple dat instances in multiple locations.

Usage

var Multidat = require('multidat')
var toilet = require('toiletdb')

var db = toilet('/tmp/dat')
Multidat(db, function (err, multidat) {
  if (err) throw err

  multidat.create(opts, function (err, dat) {
    if (err) throw err

    var dats = multidat.list()
    console.log(dats)

    multidat.close(dat.archive.key, function (err) {
      if (err) throw err
      console.log()
    })
  })
})

Error handling

If there is an error initializing a dat, instead of the whole process failing, an error object with attached .dir property will be pushed into the list of dats instead. That means when consuming multidat.list(), you should check for errors:

var dats = multidat.list()
dats.forEach(function (dat) {
  if (dat instanceof Error) {
    var err = dat
    console.log('failed to initialize dat in %s: %s', err.dir, err.message)
  }
})

This way you can decide for yourself whether an individual initialization failure should cause the whole process to fail or not.

API

Multidat(db, opts, callback(err, multidat))

Creat a new Multidat instance. Takes a toiletdb instance and a callback.

Options:

  • Dat: Use provided dat factory instead of dat-node

multidat.create(dir, opts, callback(err, dat))

Create a new dat archive.

dats = multidat.list()

List all available dat archives.

multidat.close(key, callback(err))

Close and remove a dat archive.

multidat.readManifest(dat, callback(err, manifest))

Read the dat.json file from the dat archive. This method is expected to be deprecated once dat archives provide a built-in method to return archives.

Why?

This package exists to manage multiple dat archives in different directories. The dat-node package is mostly stateless; all state is persisted into the archives themselves. This package acts as a layer on top to keep track of where archives are located and manage them between sessions.

When not to use this

If you're running a server, it's usually enough to run mafintosh/hypercore-archiver which is more consistent and simpler. If you're building a tool that only needs to manage a single dat archive at the time it's recommended to use datproject/dat-node instead.

See Also

License

MIT

multidat's People

Contributors

garbados avatar juliangruber avatar martinheidegger avatar ninabreznik avatar yoshuawuyts avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

multidat's Issues

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.