files-js

My personal library to handle files in nodejs

Install

npm i files-js

Import

import { file_exists, ls_dir, mkdir, write_file, read_file } from 'files-js';

Synchronous function

file_exists.

/*
returns true if the file exists
@param {String} path
*/
file_exists(path)

file_not_exists.

/*
@param {String} path
*/
file_not_exists(path)

ls_dir.

/*
list all files from a directory path
this function returns a list of all values from a directory
@param String path
*/
ls_dir(path)

ls_dirs.

/*
list directories
this function returns a list of directories within the passed directory
@param String path
*/
ls_dirs(path)

ls_files.

/*
list all files in a directory
this function returns a list of files within the passed directory
@param String path
*/
ls_files(path)

mkdir.

/*
this is a humble function that makes a directory that is passed
If the directories recursively
@param {string} path to directory
relative paths are from the current working dir
ex:./data/mined/companies
*/
mkdir(path)

write_file.

/*
this is a humble function that makes a file and writes a string on it
@param {string} path to directory
@param {string} string to be written
*/
write_file(path, string = '')

read_file.

/*
reads a text from a file and returns as a string
@param {string} path to directory
*/
read_file(path)

mv.

/*
remove a file
@param {String} from_path
@param {String} to_path
*/
mv(from_path, to_path)

rm_file.

/*
remove a file
@param {String} path
*/
rm_file(pat)

rm_dir.

/*
remove a directory, with options, can be passed
@param {String} path
@obj {
  recursive: true
  force: true
  } options
*/
rm_dir(path, options)

JSON Functions

write_json.

/*
@param {} obj
@param {} path
*/
write_json(obj, path) 

read_json.

/*
@param {} path
*/
read_json(path)

delete_json.

/*
@param {} path
*/
delete_json(path)

Binary functions

read_binary.

/*
this function reads a binary file from the disk
return a binary buffer obj
@param {} path
*/
read_binary(path)

write_binary.

/*
this function writes down a binary file to disk
from a binary buff
@param {} buff
@param {} path
*/
write_binary(buff, path)

write_binstr.

/*
this function writes down a binary string to disk
@param {} bin_string
@param {} path
*/
write_binstr(bin_str, path)