Package Exports

restafary
restafary/client

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

Readme

Restafary

REST for CRUD file operations.

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 restafary --save

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
		`hash`		get file hash
		`download`		content disposition attachment
	`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 restafary = require('restafary');
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(restafary({
    prefix: '/fs',  // default
    root: '/',      // default, can be string or function
}));

app.use(express.static(__dirname));
server.listen(port, ip);

License

MIT