wfs-local

Web File System - Local files driver
=========


File system abstraction with access management.

API provides common file operations for some folder on local drive. Any operations outside of the folder will be blocked. Also, it possible to configure a custom policy for read/write operations.

Can be used as backend for Webix File Manager https://webix.com/filemanager

API

$3

``js
const wfs = require("wfs-local");
const fs = new wfs.LocalFiles("/temp/folder");

// get files in a folder
let files = await fs.list("/subfolder");

// get files in a folder and subfolders as plain list
let files = await fs.list("/subfolder", { subFolders: true });

// get files in a folder and subfolders as nested structure
let files = await fs.list("/subfolder", { subFolders: true, nested:true });

// get folder only
let files = await fs.list("/subfolder", { skipFiles: true });

// get files that match a mask
let files = await fs.list("/subfolder", { include: file => file.value.includes("name")});

// get files with specific types
let files = await fs.list("/subfolder", { include: file => ["txt","doc"].includes(file.type) });

// get files created on or after January 1, 2025
let files = await fs.list("/subfolder", { include: file => new Date(file.date) >= new Date("2025-01-01")});

// get files smaller than 1 MB
let files = await fs.list("/subfolder", { include: file => file.size < 1024*1024});

// ignore some files
let files = await fs.list("/subfolder", { exclude: file => file.value === ".git" });

// get info about a single file
let info = await fs.info("some.txt");

// check if file exists
let check = await fs.exists("some.txt");
`

$3

`js
// make folder
await fs.mkdir("sub2");

// remove
await fs.remove("some.txt");

// copy
await fs.copy("some.txt", "/sub/");

// move
await fs.copy("some.txt", "some-data.txt");

// read
let stream = await fs.read("some.txt");

// write
await fs.write("some.txt", stream)
`

$3

`js
// ForceRoot policy is added automatically

// readonly
const wfs = require("wfs-local");
const fs = new wfs.LocalFiles("/temp/folder", new wfs.policies.ReadOnlyPolicy());

// custom
const fs = new wfs.LocalFiles("/temp/folder", {
comply: (path, op) => {
if (op == wfs.Operation.Read) return true;
// write to temp folder only
if (file.indexOf("/path/") === 0) return true;

return false;
}
});
`

$3

`js
// logging
const wfs = require("wfs-local");
const fs = new wfs.LocalFiles("/temp/folder", null, { verbose: true });
``

License

MIT