trufs

Contents

• About
• Features
• Installation
• Usage
• Documentation
• Links
  • Change Log

About

Trusty file methods.

Features

• Respects CommonJS
• Secure with Atomically
• Stable with Graceful FS
• Functional with FS Extra

Installation

NPM

npm install trufs

PNPM

pnpm install trufs

Yarn

yarn add trufs

Bun

bun add trufs

Deno

deno install npm:trufs

Usage

It is enough to change the fs to trufs.

- const fs = require("fs");
+ const fs = require("trufs");

fs.writeFileSync("./config.json", JSON.stringify({}));

Documentation

Methods

readFile(filepath, options?)

Read file asynchronous.

Parameter	Description
filepath	String File path to read.
options	Object (optional) Method options. More details

returns Promise<String | Buffer>

Example:

await fs.readFile("./config.json");

readFileSync(filepath, options?)

Read file synchronous.

Parameter	Description
filepath	String File path to read.
options	Object (optional) Method options. More details

returns String | Buffer

Example:

fs.readFileSync("./config.json");

writeFile(filepath, data, options?)

Write file asynchronous.

Parameter	Description
filepath	String File path to write.
data	String | Buffer Data to be written.
options	Object (optional) Method options. More details

returns Promise<Void>

Example:

await fs.writeFile("./config.json", JSON.stringify({}));

writeFileSync(filepath, data, options?)

Write file synchronous.

Parameter	Description
filepath	String File path to write.
data	String | Buffer Data to be written.
options	Object (optional) Method options. More details

returns Void

Example:

fs.writeFileSync("./config.json", JSON.stringify({}));

Links

• Change Log

License

MIT