# v_file_system

> Safe and easy way to read, write and delete files and directories....plus few additional things.

Latest version **1.0.5** (published 2021-12-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install v_file_system
pnpm add v_file_system
yarn add v_file_system
bun add v_file_system
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-12-15 |
| First published | 2021-11-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 95.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | V-core9 |
| Maintainers | v-core9 |
| Keywords | fs, promise, sync, file, directory, read, write, delete, file system, file system sync, file system promise, file system async |

## Links

- npm: https://www.npmjs.com/package/v_file_system
- Repository: https://github.com/V-core9/v_file_system
- Homepage: https://github.com/V-core9/v_file_system#readme
- Issues: https://github.com/V-core9/v_file_system/issues
- npm.io page: https://npm.io/package/v_file_system

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2021-12-15
- 1.0.4 — 2021-12-15
- 1.0.3 — 2021-11-30
- 1.0.2 — 2021-11-30
- 1.0.1 — 2021-11-14
- 1.0.0 — 2021-11-14

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

---
_Source: https://npm.io/package/v_file_system · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._