Package Exports
- @coboxcoop/drive
- @coboxcoop/drive/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@coboxcoop/drive) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
drive
Table of Contents
About
CoBox is an encrypted p2p file system and distributed back-up tool. README provides a map of the project.
drive wraps KappaDrive with some async functions and handlers for easy use in the API.
Install
npm install @coboxcoop/driveUsage
See tests for usage.
API
const Drive = require('@coboxcoop/drive')
var drive = Drive(opts)
Returns a drive object. All opts are passed down to kappa-drive.
drive.ready(callback)
callback is called when the drive is ready to use.
drive.mount
mounts a kappa-drive to a file system location using fuse-native
drive.unmount
unmounts the drive
drive.isMounted
boolean for whether drive is currently mounted
drive.ls
returns a list of file stat objects
drive.size
outputs the total bytes used by all hyperdrives that compose the kappa-drive
Contributing
PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.