Contents

• About
• Features
• Installation
• Documentation
  • Import
  • Methods
  • Types
• Links
  • Change Log

About

Trusty file methods.

Features

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

Installation

You can install it as follows.

// NPM
npm install trufs

// PNPM
pnpm install trufs

// Yarn
yarn add trufs

// Bun
bun add trufs

// Deno
deno install npm:trufs

Documentation

Import

It is enough to change the fs to trufs.

TypeScript

- import fs from "fs";
+ import { fs, type Types as TrufsTypes } from "trufs";

JavaScript

- import fs from "fs";
+ import { fs } from "trufs";

Methods

fs.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:

const reading: string | Buffer = await fs.readFile("./config.json");

fs.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:

const reading: string | Buffer = fs.readFileSync("./config.json");

fs.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:

const writing: unknown = await fs.writeFile("./config.json", JSON.stringify({}));

fs.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:

const writing: unknown = fs.writeFileSync("./config.json", JSON.stringify({}));

Types

Type	Place
Fs	fs

Example:

import { fs, type Types as TrufsTypes } from "trufs";

const Trufs: TrufsTypes.Fs = fs;

const writing: unknown = Trufs.writeFileSync("./config.json", JSON.stringify({}));
const reading: string | Buffer = Trufs.readFileSync("./config.json");

Links

• Change Log

License

MIT