https://github.com/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.
https://github.com/v-core9/v_file_system

async await files fs isdir isfile jest mkdir node-js nodefs nodejs promises sync unit-test v-core9 v-file-system write writesync

Last synced: 5 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/v-core9/v_file_system
• Owner: V-core9
• Created: 2021-08-11T20:02:41.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T17:27:39.000Z (over 3 years ago)
• Last Synced: 2025-04-05T07:09:59.708Z (about 1 year ago)
• Topics: async, await, files, fs, isdir, isfile, jest, mkdir, node-js, nodefs, nodejs, promises, sync, unit-test, v-core9, v-file-system, write, writesync
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/v_file_system
• Size: 618 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 🔽 v_file_system => v_fs 

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

[![njsscan sarif](https://github.com/V-core9/v_fs/actions/workflows/njsscan-analysis.yml/badge.svg)](https://github.com/V-core9/v_fs/actions/workflows/njsscan-analysis.yml) [![OSSAR](https://github.com/V-core9/v_fs/actions/workflows/ossar-analysis.yml/badge.svg)](https://github.com/V-core9/v_fs/actions/workflows/ossar-analysis.yml)  

---

## ➿ 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

![Test and Coverage with Jest](v_fs.coverage.png)

---

### 👻 Author: **-<[\_.⟁.\_]>-**  

### ⏰ CreatedTime: 11.08.2021 @ 21:51