Readbox NPM | npm.io

Readbox

Read file or directory from dropbox.

Install

npm i readbox

API

readbox requires token as first parameter

readbox(token, path, options, fn)

token - string
path - string
options - object can contain:
- sort - sort by: name, size, date
- order - "asc" or "desc" for ascending and descending order (default: "asc")
- type - when "raw" returns not formatted result
- root - root directory to cut from result
fn - function callback

Example

const sort = 'size';
const order = 'desc';
const token = 'token';
const path = '/';
const type = 'raw';

const readbox = require('readbox');

const stream = await readbox(token, path, {
    type,
    sort,
    order,
});

console.log(stream.type);
// outputs
'directory';

stream.pipe(process.stdout);
// outputs
({
    path: '/',
    files: [{
        name: 'readbox.js',
        size: 4735,
        date: 1_377_248_899_000,
        owner: 0,
        mode: 0,
    }, {
        name: 'readify.js',
        size: 3735,
        date: 1_377_248_899_000,
        owner: 0,
        mode: 0,
    }],
});

const stream2 = await readbox(token, '/dropbox.html');
console.log(stream2.type);
// outputs
'file';

stream.pipe(process.stdout);