@hoge1e3/sfile NPM

@hoge1e3/sfile

node.js fs Comprehensive File Wrapper

Build

npm install
npm run build

Test

npm run test

If "All test Passed." is shown, the test is succeeded.

Example

In node.js, first get FS object by await getNodeFS(). Then, FS.get() returns a File Object which can wraps fs library.

import {getNodeFS} from "@hoge1e3/sfile";
async function main() {     
    const FS=await getNodeFS();
    var mydir=FS.get("./mydir/");// directory 
    mydir.mkdir();
    var myfile=mydir.rel("myfile.txt");  // File /mydir/myfile.txt
    myfile.text("my content"); // write file
    console.log(myfile.text()); // read file
    for (let f of mydir.listFiles()) { // list files in mydir
        console.log(f.name());
    }
}
main();

Quick Reference of File Object

File Object(class SFile) can be get by calling FS.get(path).
In the methods listed below, f and d is a File Object which represents a file and directory respectively. fd can be either file or directory.
If filepath or filename represents directory, / MUST be present at last of filepath or filename

f.text(str) write str to the file
f.text() returns file content of the file in string
f.obj(o) write object o in JSON to the file
f.obj() returns the file content as object. The content of the file should be written in JSON
f.bytes(b) write ArrayBuffer/Buffer(node) to the file
f.bytes() returns file content as ArrayBuffer(browser)/Buffer(node)
f.getBytes({binType:ArrayBuffer}) returns file content as ArrayBuffer(both in browser and node)
d.each(func) iterates over the directory by passing each File Object to func
d.recursive(func) iterates over all files in the directory and its subdirectory by passing each File Object to func
d.recursive() returns Generator which iterates over all files in the directory and its subdirectory.
d.listFiles() returns array of File Objects which represents all files in the directory
d.ls() returns array of names of all files in the directory
d.rel(relPath) returns new File Object specified by the relative path
fd.relPath(base) returns the relative path of the file from the base File Object.
fd.up() returns new File Object which is parent of the file/directory.
fd.sibling(name) same as fd.up().rel(name).
fd.path() returns the full path of the file/directory.
fd.name() returns the name of the file/directory.
fd.ext() returns the extention of the file/directory.
fd.truncExt(e) returns the name removing e (when e is omitted, e equals to fd.ext() )
f.lastUpdate() return the file's time stamp as the number corrensponding to the value of Date.getTime
f.rm() removes the file
d.rm() removes the directory if it is empty.
d.rm({r:true}) removes the directory and all subfiles/subdirectories.
fd.exists() checks whether the file/directory exists.
fd.isDir() checks whether the File Object is directory.
f.copyFrom(src) copies from src(File Object) to the file.
- If src is a directory. It is same as cp -R src/* f/* in unix command. NOT cp src/ f/.
f.copyTo(dst) copies the file to dst(File Object).
- It is same as cp -R f/* dst/*, NOT cp f/ dst/.
f.moveFrom(src) moves from src(File Object) to the file.
f.moveTo(dst) moves the file to dst(File Object).
d.mkdir() creates the directory.