V-core9/v_file_system

V_FS - Helper module for easy and safe way to save/delete/read... using node fs built in module. Has both SYNC and PROMISE based options.

🔽 v_file_system => v_fs

<[-v-]> Node Module File System Handler

---

➿ How To Install

Just run the install command

npm install v_file_system --save

🎮 How to use

Well just load it as a constant...

const v_fs = require('v_file_system');

v_fs.statsDir('.');

---

🔱 ASYNC

🔹 v_fs.{methodName}

v_fs.mkdir (path, options = {}) ;
v_fs.write(filePath, content, encoding = 'utf8') ;
v_fs.deleteFile (filePath);
v_fs.isDir (dirPath);
v_fs.isFile (filePath);
v_fs.read (filePath,  encoding = "utf8");
v_fs.removeDir (dirPath, options = {recursive: true});
v_fs.statsDir (dirPath);
v_fs.statsFile (filePath);
v_fs.copy (filePath, destinationPath);

🔹 v_fs.promise.{methodName}

v_fs.promise.mkdir (path, options = {}) ;
v_fs.promise.write(filePath, content, encoding = 'utf8') ;
v_fs.promise.deleteFile (filePath);
v_fs.promise.isDir (dirPath);
v_fs.promise.isFile (filePath);
v_fs.promise.read (filePath,  encoding = "utf8");
v_fs.promise.removeDir (dirPath, options = {recursive: true});
v_fs.promise.statsDir (dirPath);
v_fs.promise.statsFile (filePath);
v_fs.promise.copy (filePath, destinationPath);

---

🚦 SYNC

🔸 v_fs.{methodName + "Sy"} - - - -

v_fs.mkdirSy (path, options = {}) ;
v_fs.writeSy (filePath, content, encoding = 'utf8') ;
v_fs.deleteFileSy (filePath);
v_fs.isDirSy (dirPath);
v_fs.isFileSy (filePath);
v_fs.readSy (filePath,  encoding = "utf8");
v_fs.removeDirSy (dirPath, options = {recursive: true});
v_fs.statsDirSy (dirPath);
v_fs.statsFileSy (filePath);

🔸 v_fs.sync.{methodName}

v_fs.sync.mkdir (path, options = {}) ;
v_fs.sync.write(filePath, content, encoding = 'utf8') ;
v_fs.sync.deleteFile (filePath);
v_fs.sync.isDir (dirPath);
v_fs.sync.isFile (filePath);
v_fs.sync.read (filePath,  encoding = "utf8");
v_fs.sync.removeDir (dirPath, options = {recursive: true});
v_fs.sync.statsDir (dirPath);
v_fs.sync.statsFile (filePath);

---

🔂 ByteSizer

Byte to >

v_fs.byteSizer.byteToKilo(size)
v_fs.byteSizer.byteToMega(size)
v_fs.byteSizer.byteToGiga(size)
v_fs.byteSizer.byteToTera(size)

Kilobyte to >

v_fs.byteSizer.kiloToByte(size)
v_fs.byteSizer.kiloToMega(size)
v_fs.byteSizer.kiloToGiga(size)
v_fs.byteSizer.kiloToTera(size)

Megabyte to >

v_fs.byteSizer.megaToByte(size)
v_fs.byteSizer.megaToKilo(size)
v_fs.byteSizer.megaToGiga(size)
v_fs.byteSizer.megaToTera(size)

Gigabyte to >

v_fs.byteSizer.gigaToByte(size)
v_fs.byteSizer.gigaToKilo(size)
v_fs.byteSizer.gigaToMega(size)
v_fs.byteSizer.gigaToTera(size)

Terabyte to >

v_fs.byteSizer.teraToByte(size)
v_fs.byteSizer.teraToKilo(size)
v_fs.byteSizer.teraToMega(size)
v_fs.byteSizer.teraToGiga(size)

✅ Test Results and Coverage with Jest

---

👻 Author: -<[_.⟁._]>-

⏰ CreatedTime: 11.08.2021 @ 21:51