# disk-dropbox

> Virtual Volume / FileSystem backed by Dropbox

Latest version **1.0.0** (published 2014-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install disk-dropbox
pnpm add disk-dropbox
yarn add disk-dropbox
bun add disk-dropbox
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2014-07-25 |
| First published | 2014-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonas Hermsmeier |
| Maintainers | jhermsmeier |
| Keywords | fs, filesystem, dropbox, disk |

## Links

- npm: https://www.npmjs.com/package/disk-dropbox
- Repository: https://github.com/jhermsmeier/node-disk-dropbox
- Issues: https://github.com/jhermsmeier/node-disk-dropbox/issues
- npm.io page: https://npm.io/package/disk-dropbox

## Dependencies (1)

- [dropbox](https://npm.io/package/dropbox.md) ^0.10.3

## 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.0 (latest) — 2014-07-25

## README

# Dropbox File System

[![npm](http://img.shields.io/npm/v/disk-dropbox.svg?style=flat)](https://npmjs.org/disk-dropbox)


Install via [npm](https://npmjs.org)
------------------------------------
```sh
$ npm install disk-dropbox
```


## Usage Example

```js
var Dropbox = require( 'disk-dropbox' )

// Create a volume with your credentials
var volume = new Dropbox.Volume({
  key: 'xxxxxxxxxxxxxxx',
  secret: 'xxxxxxxxxxxxxxx',
  token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  uid: '00000000'
})

// Initialize the volume
volume.init( function( error ) {
  if( error ) { handleError( error ) }
  // You're authenticated now, and `volume.fs`
  // has node fs module compatible API (see 'disk-fs' module)
  volume.fs.readdir( '/', function( error, entries ) {
    console.log( 'readdir', entries )
  })
})
```

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