# @coboxcoop/drive

> extension of kappa-drive for cobox space

Latest version **1.0.5-alpha.1** (published 2022-04-07) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @coboxcoop/drive
pnpm add @coboxcoop/drive
yarn add @coboxcoop/drive
bun add @coboxcoop/drive
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5-alpha.1 |
| Published | 2022-04-07 |
| First published | 2020-07-29 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | magma-collective |
| Maintainers | kyphae, ameba23 |
| Keywords | cobox, kappa-core, fs, drive, kappa, peerfs, space, kappa-drive |

## Links

- npm: https://www.npmjs.com/package/@coboxcoop/drive
- Repository: https://gitlab.com/coboxcoop/drive
- Homepage: https://cobox.cloud
- Issues: https://gitlab.com/coboxcoop/drive/issues
- npm.io page: https://npm.io/package/@coboxcoop/drive

## Dependencies (8)

- [assert](https://npm.io/package/assert.md) ^2.0.0
- [kappa-core](https://npm.io/package/kappa-core.md) github:Frando/kappa-core#exp-0.2.3
- [kappa-drive](https://npm.io/package/kappa-drive.md) ^3.1.1
- [call-me-maybe](https://npm.io/package/call-me-maybe.md) ^1.0.1
- [@coboxcoop/crypto](https://npm.io/package/@coboxcoop/crypto.md) ^1.0.2-alpha.1
- [@coboxcoop/logger](https://npm.io/package/@coboxcoop/logger.md) 1.0.1-alpha.1
- [kappa-drive-mount](https://npm.io/package/kappa-drive-mount.md) ^1.2.0
- [@coboxcoop/constants](https://npm.io/package/@coboxcoop/constants.md) ^1.0.1-alpha.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.5-alpha.1 (latest) — 2022-04-07
- 1.0.4-alpha.1 — 2021-06-11
- 1.0.3-alpha.1 — 2020-07-29
- 1.0.2-alpha.1 — 2020-07-29
- 1.0.1-alpha.1 — 2020-07-29
- 1.0.0-alpha.1 — 2020-07-29

## README

# drive

<div align="center">
  <img src="https://cobox.cloud/src/svg/logo.svg">
</div>

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

## Table of Contents

  - [About](#about)
  - [Install](#install)
  - [Usage](#usage)
  - [API](#api)
  - [Contributing](#contributing)
  - [License](#license)

## About
**CoBox** is an encrypted p2p file system and distributed back-up tool. [README](https://gitlab.com/coboxcoop/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/drive
```

## Usage

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](https://github.com/RichardLitt/standard-readme) specification.

# License

[`AGPL-3.0-or-later`](./LICENSE)

---
_Source: https://npm.io/package/@coboxcoop/drive · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
