Node FS wrapper for Dropbox API
npm install dropbox-fsNode fs wrapper for Dropbox. Wraps the Dropbox javascript module with an async fs-like API so it can be used where a fileSystem API is expected.
To use this module you'll need a Dropbox Access Token.
`` bash`
$ npm install --save dropbox-fs
` js
const dfs = require('dropbox-fs')({
apiKey: 'DROPBOX_API_KEY_HERE'
});
dfs.readdir('/Public', (err, result) => {
console.log(result); // Array of files and folders
});
`
Promises are also supported.
`js`
const dfs = require('dropbox-fs/promises')({
apiKey: 'DROPBOX_API_KEY_HERE'
});
You can also pass in a client option if you’re using your own dropbox module instead of the apiKey.
If you'd like some peace of mind then there's a read-only option too:
` js
const dfs = require('dropbox-fs/readonly')({
apiKey: 'DROPBOX_API_KEY_HERE'
});
// Methods that might change data now return an error without performing any action:
// - mkdir
// - rename
// - rmdir
// - unlink
// - writeFile
dfs.unlink('/Public', (err) => {
console.log(err); // Message saying unlink is not supported in read-only`
});
This module exposes the following methods:
Reads a directory and returns a list of files and folders inside.
` js`
dfs.readdir('/', (err, result) => {
console.log(result);
});
- path: String|Buffercallback
- : Function
Creates a directory.
` js`
dfs.mkdir('/Public/Resume', (err, stat) => {
console.log(stat.name); // Resume
console.log(stat.isDirectory()); // true
});
- path: String|Buffercallback
- : Function
Deletes a directory.
` js`
dfs.rmdir('/Public/Resume', err => {
if (!err) {
console.log('Deleted.');
}
});
- path: String|Buffercallback
- : Function
Reads a file and returns it’s contents.
` js
// Buffer:
dfs.readFile('/Work/doc.txt', (err, result) => {
console.log(result.toString('utf8'));
});
// String
dfs.readFile('/Work/doc.txt', {encoding: 'utf8'}, (err, result) => {
console.log(result);
});
`
- path: String|Bufferoptions
- : Optional String|Objectencoding
- : Stringcallback
- : Function
If you pass a string as the options parameter, it will be used as options.encoding. If you don’t provide an encoding, a raw Buffer will be passed to the callback.
Writes a file to the remote API and returns it’s stat.
` js`
const content = fs.readFileSync('./localfile.md');
dfs.writeFile('/Public/doc.md', content, {encoding: 'utf8'}, (err, stat) => {
console.log(stat.name); // doc.md
});
- path: String|Bufferdata
- : String|Bufferoptions
- : Optional String|Objectencoding
- : Stringoverwrite
- : Boolean Default: true.callback
- : Function
Renames a file (moves it to a new location).
` js`
dfs.rename('/Public/doc.md', '/Backups/doc-backup.md', err => {
if err {
console.error('Failed!');
} else {
console.log('Moved!');
}
});
- path: String|Bufferdata
- : String|Buffercallback
- : Function
Returns the file/folder information.
` js`
dfs.stat('/Some/Remote/Folder/', (err, stat) => {
console.log(stat.isDirectory()); // true
console.log(stat.name); // Folder
});
- path: String|Buffercallback
- : Functionerr
- : null|Errorstat
- : Stat Object
Deletes a file.
` js`
dfs.unlink('/Path/To/file.txt', err => {
if (!err) {
console.log('Deleted!');
}
});
- path: String|Buffercallback
- : Function
Creates a readable stream.
` js`
const stream = fs.createReadStream('/test/test1.txt');
stream.on('data', data => {
console.log('data', data);
});
stream.on('end', () => {
console.log('stream finished');
});path
- : String|Buffer
Creates a writable stream.
` js
const stream = fs.createWriteStream('/test/test1.txt');
someStream().pipe(stream).on('finish', () => {
console.log('write stream finished');
});
`
- path: String|Buffer
The stat object that is returned from writeFile() and stat() contains two methods in addition to some standard information like name, etc:
- stat.isDirectory() Returns true if the target is a directorystat.isFile()
- Returns true` if the target is a file
This software is released under the MIT License.