restbox
v4.0.1
Published
REST for CRUD file operations on dropbox
Downloads
1,013
Maintainers
Readme
Restbox [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
REST for CRUD file operations on dropbox
.
What is it?
REpresentational State Transfer is an abstraction of the architecture of the World Wide Web.
Create Read Update Delete is 4 basic functions of persistent storage.
Install
npm i restbox
REST
|Name |Method |Query |Body |Description |
|:------------|:--------|:--------------|:------------------|:------------------------------|
|fs
|GET
| | |get file or dir content |
| | |sort
| |sort dir content by name
, |
| | | | |size
, or time
|
| | |order
| |order of sorting, can be: |
| | | | |asc
or desc
|
| | |raw
| |get file or raw dir content |
| | |size
| |get file or dir size |
| | |time
| |get time of file change |
| | |hash
| |get file hash |
| |PUT
| |file content |create/write file |
| | | unzip
|file content |unzip and create/write file |
| | | dir
| |create dir |
| |PATCH
| |diff |patch file |
| |DELETE
| | |delete file |
| | |files
|Array of names |delete files |
How to use?
const restbox = require('restbox');
const http = require('http');
const express = require('express');
const app = express();
const server = http.createServer(app);
const port = 1337;
const ip = '0.0.0.0';
app.use(restbox({
token: 'your dropbox token',
prefix: '/dropbox', // default
root: '/', // default, can be string or function
}));
app.use(express.static(__dirname));
server.listen(port, ip);
License
MIT