youfile v1.0.8

YouFile

Manage your files and folders quickly and easily

When doing write, copy, move if the directory does not exist it will be created automatically.

Installation

Module

import yfile from "youfile";

Commonjs

const yfile = require("youfile");

File creation

You can create files with objects as well as with strings.

With strings:

yfile.write.file(path, "data");

With objects:

yfile.write.json(path, { data: true });

You can also define the amount of formatting spaces in the json file, default is 0.

yfile.write.json(path, { data: true }, 4);

Folder creation

If when creating the folder the directory does not exist, it will be created automatically.

yfile.write.dir(path);

Reading files and directories

Files

Returns the contents of the file in a string:

yfile.read.file(path);

Returns the contents of the file in an object:

yfile.read.json(path);

You can also read files with comments:

yfile.read.json5(path);

Directories

Returns an array with all folders that are in the same directory:

yfile.read.dir.getFolders(path);

Returns an array with all the files that are in the same directory:

yfile.read.dir.getFiles(path);

Returns an array with all the files with a specified extension that are in the same directory:

yfile.read.dir.getExtnameFiles(path, ".ext");

Returns an array with all the folders contained in the directory:

yfile.read.dir.getAllFolders(path);

Returns an array with all the files contained in the directory:

yfile.read.dir.getAllFiles(path);

Returns an array with all files with a specified extension contained in the directory:

yfile.read.dir.getAllExtnameFiles(path, ".ext");

Deletes files and directories

yfile.remove(path);

Copy files and directories

yfile.copy(path, dest);

Move files and directories

yfile.move(path, dest);