Fileger

The most convinient way to work with Files in NodeJS

Notices

If you catch any errors feel free to write a mail [e-mail] or create an issue on GitHub.

Installation

Install Filegervia NPM

npm install fileger

Examples

File

This example creates the file configuration.json, writes some things in it and then read it's contents and fileSize and then prints it to the console. Then it encrypts the file, copies the encrypted file, then decrypts it and then deletes it.

// import the `File` class from `fileger`
const { File } = require("fileger")
 
const run = async () => {
 
    const file = new File("./configuration.json");
 
    // object that will be written to the file
    const configuration = {
        version: 2.3,
        inProduction: true
    }
    
    await file.create();                               // creates the file
    await file.write(JSON.stringify(configuration));   // writes the configuration object to the file
    const content = await file.read();                 // reads the file
    const fileSize = await file.getFileSize();         // gets the size of the file in megabytes
 
    console.log("Configuration File:" + JSON.parse(content) + `
    And has a size of ` + fileSize + "MB!")
 
    await file.encrypt("Password");                                 // encrypts the file with the password 'Password'
    const copiedFile = await file.copy("configurationCopy.json")    // copies the encrypted file
    await copiedFile.decrypt("Password");                           // decrypts the copied File
    await copiedFile.delete();                                      // deletes the copied File
 
}
 
run();

Directory

This example creates the directory ExampleFolder, list all it's contents, encrypts all it's contents, copies the encrypted contents, then decrypts the copied directory and then zips it to the directory zippedFolder.zip.

// import the `Directory` class from `Fileger`
const { Directory } = require("fileger")
 
const run = async () => {
 
    const dir = new Directory("./ExampleFolder");
 
    await dir.create(); // creates the directory
 
    const content = await dir.list();                       // lists all files and directories of the directory
    content.forEach(element => console.log(element.path));  // prints out all the file and directory paths
 
    await dir.encrypt("example-password")                       // encrypts all the files and directories with the password `example-password`
    const copiedDir = await dir.copy("./copiedExampleFolder");  // copies the directory
    await copiedDir.decrypt("example-password")                 // decrypts all the files and directories of the copied directory
    copiedDir.zip("zipppedFolder.zip")                          // zips the copiedFolder
 
}
 
run();

Usage

CLI

Fileger also can be used as a CLI. To install it run:

npm install -g fileger

To see all commands run:

fl help