JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 515
  • Score
    100M100P100Q99998F
  • License MIT

Upload & Download streams for Dropbox

Package Exports

  • dropbox-stream

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 (dropbox-stream) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Dropbox Stream

NPM Version NPM Downloads

Upload & Download streams for Dropbox

Install

npm i dropbox-stream

Usage

Upload

Uploads stream to dropbox using upload session API

Events order:

  1. progress
  2. metadata
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
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:

db.createDropboxDownloadStream({
  token: TOKEN,
  url: 'sharedlink',
  path: 'optional file path if shared link is for a folder'
})

License MIT