Restafary [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]

[NPMIMGURL]: https://img.shields.io/npm/v/restafary.svg?style=flat
[BuildStatusURL]: https://github.com/coderaiser/node-restafary/actions?query=workflow%3A%22Node+CI%22 "Build Status"
[BuildStatusIMGURL]: https://github.com/coderaiser/node-restafary/workflows/Node%20CI/badge.svg
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/restafary "npm"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"

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 |
| | |raw-size | |get raw 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?

``js
import http from 'node:http';
import {restafary} from 'restafary';
import express from '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