README.md

SniperCode.FileSystem

Table of Contents

• SniperCode.FileSystem
  • Table of Contents
  • Introduction
  • Installation
  • Uninstall
  • Exposed API
    • File
  • Release

Introduction

SniperCode.FileSystem is a file system library for JavaScript providing a simple and easy to use file system API based on Node.js. It is designed to be used in a Node.js environment and a core part for file handling.

Installation

To install SniperCode.FileSystem, run the following command:

    npm install snipercode.filesystem

Uninstall

To uninstall SniperCode.FileSystem, run npm uninstall snipercode.filesystem.

Exposed API

All the exposed API is documented below.

File

This API is used to access file system and self explanatory endpoints. Example:

    const {
        File_System
    } = require('SniperCode.FileSystem');

    // All the exposed endpoints are static methods of File_System class so you can access them directly.

    // Example:
        console.log(File_System.scan_dir('./))
    // Prints the list of files and directories in the current directory.

All the endpoints are listed below.

1. File_System.path_resolve
2. File_System.is_file
3. File_System.file_path
4. File_System.file_ext
5. File_System.file_name
6. File_System.file_name_with_ext
7. File_System.file_size
8. File_System.file_exists
9. File_System.file_stats
10. File_System.read_file
11. File_System.write_file
12. File_System.update_file
13. File_System.append_file
14. File_System.delete_file
15. File_System.rename_file
16. File_System.copy_file
17. File_System.move_file
18. File_System.is_dir
19. File_System.dir_path
20. File_System.dir_name
21. File_System.dir_exists
22. File_System.scan_dir
23. File_System.search_dir
24. File_System.scan_dir_recursive_depth
25. File_System.scan_dir_recursive
26. File_System.mkdir
27. File_System.rename_dir
28. File_System.copy_dir
29. File_System.delete_dir

Release

Visit GitHub Release to see the latest release.