fs-manage
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

README.md 示例

# fs-manage

A utility library for file operations in Node.js.

## Features

- Check if a path is a file
- Read file data
- Create directories
- Write file data (with optional overwrite)
- Write large file data in stream (with optional overwrite)
- Record entries as JSON array in a file

## Installation

To install the package, you can use npm:

```bash
npm install fs-manage
```

Usage

Importing the Library

const {
  isFile,
  getFileData,
  createDir,
  writeFileData,
  writeBigFileData,
  entryRecords,
} = require("fs-manage");

Check if a Path is a File

const isFile = await isFile("/path/to/file");
console.log(isFile); // true or false

Read File Data

const data = await getFileData("/path/to/file");
console.log(data);

Create a Directory

await createDir("/path/to/directory");
console.log("Directory created");

Write File Data

await writeFileData("/path/to/file", "File content", true);
console.log("File written");

Write Large File Data in Stream

await writeBigFileData("/path/to/file", "File content", false);
console.log("Large file written");

Record Entries as JSON Array in a File

await entryRecords("/path/to/file", { key: "value" });
console.log("Record added");

Package Sidebar

Install

npm i fs-manage

Weekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

16.7 kB

Total Files

7

Last publish

Collaborators

  • handdeng