Installation

To install the package, use the following command:

npm install --save node-fs-utils

Usage

Below are some minimal usage examples demonstrating how to use the node-fs-utils package.

Initialization

You can initialize the node-fs-utils using either CommonJS or ES6 syntax:

// CommonJS
const fs = require("node-fs-utils");

// ES6
import fs from 'node-fs-utils';

Read Direcory

Read the contents of a directory.

const output = await fs.config({path: <directory_path>}).readdir()
console.log(output)

[
  "test.csv",
  "test.txt",
  "test.js"
]

Get Directory Info

Get information about a file or directory.

const output = await fs.config({path: <directory_path>}).stat()
console.log(output)

{
  "dev": 16777223,
  "mode": 16893,
  "nlink": "5",
  "uid": 501,
  "gid": 20,
  "rdev": 0,
  "blksize": 4096,
  "ino": 8341104,
  "size": 160,
  "blocks": 0,
  "atimeMs": 1692462842366.5476,
  "mtimeMs": 1692462640828.8342,
  "ctimeMs": 1692462640828.8342,
  "birthtimeMs": 1687148653000,
  "atime": "2023-08-19T16:34:02.367Z",
  "mtime": "2023-08-19T16:30:40.829Z",
  "ctime": "2023-08-19T16:30:40.829Z",
  "birthtime": "2023-06-19T04:24:13.000Z"
}

Extract Class Name

Get class names from a JAR file based on a pattern.

const output = await fs.config({path: <jarfile_path>}).findClassNamesInJar(<classNamePattern>)
console.log(output)

[ "org.postgresql.Driver" ]

Copy File

source filename to copy

await fs.utils.copyFile('<source_path>', '<destination_path>')

Remove Directory

Removes the directory identified by path.

await fs.utils.rmdir('<path>')

Remove Files & Direcotry

await fs.utils.rm('<path>')