https://github.com/velocityzen/dropbox-stream
Upload & Download streams for Dropbox
https://github.com/velocityzen/dropbox-stream
download dropbox nodejs stream upload
Last synced: over 1 year ago
JSON representation
Upload & Download streams for Dropbox
- Host: GitHub
- URL: https://github.com/velocityzen/dropbox-stream
- Owner: velocityzen
- License: mit
- Created: 2016-12-22T15:41:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:36:28.000Z (over 3 years ago)
- Last Synced: 2025-03-22T20:19:37.612Z (over 1 year ago)
- Topics: download, dropbox, nodejs, stream, upload
- Language: JavaScript
- Homepage:
- Size: 638 KB
- Stars: 36
- Watchers: 2
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Dropbox Stream
[](https://www.npmjs.com/package/dropbox-stream)
[](https://www.npmjs.com/package/dropbox-stream)
Upload & Download streams for [Dropbox](https://dropbox.com)
## Install
`npm i dropbox-stream`
## Usage
### Upload
Uploads stream to dropbox using upload session API
Events order:
1. `progress`
2. `metadata`
```js
const db = require('dropbox-stream');
const TOKEN = 'put your dropbox token here';
const FILETOUPLOAD = '/some/file.txt';
const up = db.createDropboxUploadStream({
token: TOKEN,
path: '/test/' + path.basename(FILETOUPLOAD),
chunkSize: 1000 * 1024,
autorename: true,
mode: 'add'
})
.on('error', err => console.log(err))
.on('progress', res => console.log(res))
.on('metadata', metadata => console.log('Metadata', metadata))
fs.createReadStream(FILETOUPLOAD).pipe(up)
.on('finish', () => console.log('This fires before metadata!'))
```
### Download
Downloads to stream from dropbox.
Events order:
1. `metadata`
2. `progress`
```js
const db = require('dropbox-stream');
const TOKEN = 'put your dropbox token here';
const FILETODOWNLOAD = '/some/file.txt';
const FILETODOWNLOADTO = './file.txt';
db.createDropboxDownloadStream({
token: TOKEN,
path: FILETODOWNLOAD
})
.on('error', err => console.log(err))
.on('metadata', metadata => console.log('Metadata', metadata))
.on('progress', res => console.log(res))
.pipe(fs.createWriteStream(FILETODOWNLOADTO))
.on('finish', () => console.log('Done!'));
```
If you want to download a file from shared link use:
```js
db.createDropboxDownloadStream({
token: TOKEN,
url: 'sharedlink',
path: 'optional file path if shared link is for a folder'
})
```
License MIT