@reliverse/relifso 1.4.4 → 2.2.7

package/README.md

@@ -1,448 +1,452 @@
-# Relifso • Bun & Node.js Filesystem Toolkit Library
+# @reliverse/relifso
 
-[sponsor](https://github.com/sponsors/blefnk) — [discord](https://discord.gg/Pb8uKbwpsJ) — [npm](https://npmjs.com/package/@reliverse/relifso) — [github](https://github.com/reliverse/relifso)
+> Ultra-performant, Bun-first file system utilities that mirror the most commonly used `fs-extra` APIs.
 
-> @reliverse/relifso is a modern node and bun filesystem toolkit. drop-in replacement for `node:fs` and `fs-extra` — powered by native promises, built with es modules, and packed with dx-focused and bun-aware utilities.
+A drop-in replacement for `fs-extra` optimized for Bun's native file I/O APIs (`Bun.file` and `Bun.write`). Provides 100% type safety, zero dependencies, and leverages Bun's optimized syscalls (`copy_file_range`, `sendfile`, etc.) for maximum performance.
 
 ## Features
 
-- 🔥 Both Node.js and Bun-specific filesystem features are exposed via `fs.*`
-- 🪄 Everything you love from `fs-extra` — now simpler, cleaner, and more beginner-friendly
-- ⚙️ Drop-in replacement for `node:fs` — with native `Promise`, `async/await`, and sync variants
-- 🤝 Forget about `try-catch` for common errors like "file not found" — relifso does it under the hood
-- 🧯 Gracefully handles errors like `EMFILE` (reading or writing a lot of files at once) and other edge cases
-- 📚 Consistent error-first behavior — even for legacy APIs like `fs.exists()`
-- 📦 First-class ESM and full TypeScript support — no config hacks required
-- 🧼 Zero bloat — small size, zero deps, modern code, no monkey-patching
-- 🎯 Supports all Node.js v16+ features — optimized for Node.js v22+
-- 🧪 Soon: Ready for upcoming Node.js v22+ experimental features
-- ✌️ Bun v1.2+ ready — ships with Bun-aware enhancements out of the box
-- 🐦‍🔥 Finally! Your `fs.*` usage is now can correctly read/write JSON/JSONC!
-
-## Install
+- 🚀 **Ultra-fast** - Leverages Bun's native `Bun.file()` and `Bun.write()` APIs
+- 📦 **Zero dependencies** - Pure Bun/Node.js implementation
+- 🔒 **Type-safe** - Full TypeScript support with comprehensive type definitions
+- 🎯 **fs-extra compatible** - Drop-in replacement for the most commonly used APIs
+- 🪟 **Cross-platform** - Windows-aware symlink handling with junction support
+- 📊 **Well-tested** - Comprehensive benchmarks and test coverage
+
+## Installation
 
 ```bash
-# bun • pnpm • yarn • npm
 bun add @reliverse/relifso
 ```
 
-**Migrate**:
+## Quick Start
 
-```bash
-bun rm fs-extra
-bun rm @types/fs-extra
-# soon:
-# bun add -D @reliverse/dler
-# bun dler migrate fs-relifso
+### Default Import
+
+```ts
+import fs from "@reliverse/relifso";
+
+// Read and write files
+const content = await fs.readFile("package.json", { encoding: "utf8" });
+await fs.writeFile("output.txt", "Hello, Bun!");
+
+// JSON operations
+const data = await fs.readJson<{ version: string }>("package.json");
+await fs.writeJson("config.json", { port: 3000 });
+
+// Directory operations
+await fs.ensureDir("dist/assets");
+await fs.emptyDir("temp");
+await fs.remove("old-files");
+
+// Copy and move
+await fs.copy("src", "dist");
+await fs.move("old.txt", "new.txt");
 ```
 
-**Pro Tip**: _Use Ctrl+Shift+H to replace `fs-extra` with `@reliverse/relifso` in your project._
+### Named Imports
 
-### Core Features
+```ts
+import {
+  readFile,
+  writeFile,
+  readJson,
+  writeJson,
+  ensureDir,
+  copy,
+  remove,
+} from "@reliverse/relifso";
 
-- **File Operations**
-  - Read/write files with various encodings
-  - Copy/move files and directories
-  - Create/remove files and directories
-  - File existence checks
-  - File stats and metadata access
+await ensureDir("build");
+await writeFile("build/index.js", "console.log('Hello');");
+const data = await readJson("package.json");
+```
 
-- **Directory Operations**
-  - Create nested directories
-  - Empty directories
-  - Directory traversal with `dive`
-  - Directory existence checks
+## API Reference
 
-- **JSON Operations**
-  - Read/write JSON files with validation
-  - JSON repair and validation utilities
-  - JSON streaming support
-  - JSONC (JSON with Comments) support
+### File Operations
 
-- **Bun Optimizations**
-  - Automatic runtime detection
-  - Optimized file operations using Bun APIs
-  - Fast file stats and metadata access
-  - Graceful fallbacks to Node.js APIs
+#### `readFile(path, options?)`
 
-- **Utility Functions**
-  - File type detection
-  - Hidden file attribute handling
-  - Directory emptiness checks
-  - File size and last modified time access
+Read a file as a string with various encodings or binary (`Uint8Array`).
 
-### Error Handling
+```ts
+// Read as binary (default)
+const buffer: Uint8Array = await fs.readFile("image.png");
 
-- Graceful handling of common filesystem errors
-- Consistent error types and messages
-- Automatic error recovery where possible
-- Detailed error information for debugging
-- Runtime detection errors
-- File operation failures
-- All Bun-specific operations include proper error handling
-- Automatic fallback from Bun to Node.js APIs when needed
+// Read as UTF-8 string
+const text: string = await fs.readFile("file.txt", { encoding: "utf8" });
 
-## Usage
+// Supported encodings: utf8, utf-8, ascii, base64, hex, latin1, ucs-2, ucs2, utf16le, binary
+const base64: string = await fs.readFile("file.bin", { encoding: "base64" });
+const hex: string = await fs.readFile("file.bin", { encoding: "hex" });
+const ascii: string = await fs.readFile("file.txt", { encoding: "ascii" });
+const latin1: string = await fs.readFile("file.txt", { encoding: "latin1" });
+```
 
-Check [./e-relifso.ts](./e-relifso.ts) and [./e-pathkit.ts](./e-pathkit.ts) for a full examples. You can clone this repo and run via `bun dev`.
+#### `writeFile(destination, data, options?)`
 
-Relifso works just like `fs-extra` — every method is promise-first, ergonomic, and future-ready.
+Write data to a file. Accepts strings, `Uint8Array`, `Blob`, or `BunFile`.
 
 ```ts
-import { copy, pathExists, remove } from "@reliverse/relifso";
+// Write string (UTF-8 by default)
+await fs.writeFile("output.txt", "Hello, World!");
 
-await copy("src/index.ts", "dist/index.ts");
+// Write with specific encoding
+await fs.writeFile("output.txt", "Привіт", { encoding: "utf8" });
+await fs.writeFile("output.txt", "Hello", { encoding: "latin1" });
+await fs.writeFile("output.txt", "Hello", { encoding: "ascii" });
 
-if (await pathExists("dist/index.ts")) {
-  await remove("dist/index.ts");
-}
+// Write binary data
+await fs.writeFile("data.bin", new Uint8Array([1, 2, 3]));
+
+// Write from BunFile
+await fs.writeFile("copy.txt", Bun.file("original.txt"));
+
+// Write with file mode
+await fs.writeFile("script.sh", "#!/bin/bash", { mode: 0o755 });
 ```
 
-- ✨ Everything's bundled — modern, async, and type-safe.
-- 🧼 No more boilerplate like `promisify(fs.removeSync)` or using `mkdirp`, `ncp`, or `rimraf`.
-- 🌱 No more weird `try/catch` for common errors like "file not found."  
-- ✌️ Just clean, predictable APIs built for 2025 and beyond.
+#### `appendFile(file, data, options?)`
 
-## Example
+Append data to a file, creating it if it doesn't exist.
 
 ```ts
-import {
-  ensureDir,
-  outputJson,
-  readJson,
-  remove,
-} from "@reliverse/relifso";
+// Append string to file
+await fs.appendFile("log.txt", "New log entry\n");
 
-const path = "./.reliverse/config.json";
+// Append with encoding
+await fs.appendFile("log.txt", "Entry", { encoding: "utf8" });
 
-await ensureDir(".reliverse");
-await outputJson(path, { hello: "world" });
+// Append binary data
+await fs.appendFile("data.bin", new Uint8Array([1, 2, 3]));
+
+// Append with file mode (only applies when creating new file)
+await fs.appendFile("log.txt", "Entry\n", { mode: 0o644 });
+```
 
-const config = await readJson(path);
-console.log(config); // { hello: 'world' }
+#### `readJson<T>(path)`
 
-await remove(".reliverse");
+Read and parse a JSON file asynchronously.
+
+```ts
+interface PackageJson {
+  name: string;
+  version: string;
+}
+
+const pkg = await fs.readJson<PackageJson>("package.json");
+console.log(pkg.name); // Type-safe access
 ```
 
-## Run Example
+#### `readJSONSync<T>(path)`
 
-Install this repository locally and run the example by using `bun dev`:
+Read and parse a JSON file synchronously.
 
-```bash
-$ bun e-mod.ts
-✓   Running examples with Bun...
-Created directory ./tests-runtime
-[env] writeJson was successfully executed in Bun (for JSON)
-Wrote JSON tests-runtime\config.json
-[env] readJson was successfully executed in Bun
-Read JSON {"hello":"world","ts":"2025-06-02T19:01:53.291Z"}
-[env] copy was successfully executed in Bun
-Moved → Copied (with overwrite) tests-runtime\config.old.json → tests-runtime\config.copy.json
-[env] readFile was successfully executed in Bun
-Wrote & read text file Hello Relifso!
-[env] writeFile was successfully executed in Bun
-[env] writeFile was successfully executed in Bun
-Ensured nested & output files
-[env] writeJson was successfully executed in Bun (for JSON)
-[env] readJson was successfully executed in Bun
-writeJson / readJson round-trip {"foo":"bar"}
-[env] writeJson was successfully executed in Bun (for JSONC)
-Wrote JSONC tests-runtime\config.jsonc
-[env] readJson was successfully executed in Bun
-Read JSONC {
-  "name": "relifso",
-  "version": "1.0.0",
-  "features": [
-    "file operations",
-    "directory operations",
-    "JSONC support"
-  ],
-  "settings": {
-    "debug": true,
-    "verbose": false
-  }
+```ts
+interface PackageJson {
+  name: string;
+  version: string;
 }
-Emptied directory tests-runtime\empty-me
-[env] writeFileSync was successfully executed in Bun
-[env] writeJsonSync was successfully executed in Bun (for JSON)
-Sync JSON round-trip {"sync":true}
-[env] copySync was successfully executed in Bun
-copySync → moveSync → removeSync chain complete
-Directory structure via dive
- • tests-runtime\config-sync.json
- • tests-runtime\config.copy.json
- • tests-runtime\config.jsonc
- • tests-runtime\config.old.json
- • tests-runtime\config2.json
- • tests-runtime\hello.txt
- • tests-runtime\nested\deep\file.txt
- • tests-runtime\output-file.txt
-Directory structure via diveSync
- • tests-runtime\config-sync.json
- • tests-runtime\config.copy.json
- • tests-runtime\config.jsonc
- • tests-runtime\config.old.json
- • tests-runtime\config2.json
- • tests-runtime\hello.txt
- • tests-runtime\nested\deep\file.txt
- • tests-runtime\output-file.txt
-Removed directory ./tests-runtime
+
+// Synchronous version - blocks until file is read
+const pkg = fs.readJSONSync<PackageJson>("package.json");
+console.log(pkg.name); // Type-safe access
+```
+
+#### `writeJson(destination, data, options?)`
+
+Write data as JSON to a file.
+
+```ts
+await fs.writeJson("config.json", { port: 3000, host: "localhost" });
+
+// Custom indentation
+await fs.writeJson("config.json", data, { spaces: 4 });
+```
+
+#### `outputFile(destination, data, options?)`
+
+Write a file, automatically creating parent directories if needed.
+
+```ts
+// Creates "build/assets" directory if it doesn't exist
+await fs.outputFile("build/assets/style.css", "body { margin: 0; }");
 ```
 
-## Sync vs Async vs Legacy
+#### `outputJson(destination, data, options?)`
 
-You choose your flavor:
+Write JSON to a file, automatically creating parent directories.
 
 ```ts
-// Async/Await
-await copy("a.txt", "b.txt");
+await fs.outputJson("build/meta.json", { version: "1.0.0" });
+```
+
+### Directory Operations
+
+#### `ensureDir(path)`
+
+Ensure a directory exists, creating it and any necessary parent directories.
+
+```ts
+await fs.ensureDir("dist/assets/images");
+// Creates: dist/assets/images (and all parent directories)
+```
+
+#### `mkdirp(path)`
 
-// Sync
-copySync("a.txt", "b.txt");
+Alias for `ensureDir`.
+
+#### `ensureFile(path)`
+
+Ensure a file exists, creating it and any necessary parent directories.
+
+```ts
+await fs.ensureFile("logs/app.log");
+// Creates: logs/ directory and app.log file
+```
+
+#### `readdir(path, options?)`
+
+Read directory contents.
+
+```ts
+// Get file names
+const files = await fs.readdir("src");
+
+// With file types
+const entries = await fs.readdir("src", { withFileTypes: true });
+```
+
+#### `readdirRecursive(path, options?)`
+
+Recursively read all files in a directory.
+
+```ts
+// Get all files recursively
+const allFiles = await fs.readdirRecursive("src");
+
+// Filter by extension
+const tsFiles = await fs.readdirRecursive("src", {
+  extensions: ["ts", "tsx"],
+});
 
-// Callback (legacy-style)
-copy("a.txt", "b.txt", err => {
-  if (err) console.error(err);
+// Follow symlinks
+const files = await fs.readdirRecursive("src", {
+  followSymlinks: true,
 });
 ```
 
-All async methods return a `Promise` if no callback is passed.
-
-## Fully Typed, Fully Modern
-
-- Written in modern ESM
-- Minimal dependencies
-- Full TypeScript declarations
-- Compatible with Node.js 16+, best with 22+
-- Async methods are built from the sync versions — no wrappers, no bloat
-
-## What's Inside?
-
-- All async methods follow the `Promise` pattern by default.
-- All sync methods are safe and throw errors when needed.
-
-### Async (recommended)
-
-#### Common Async Methods
-
-- [access](https://uwx-node-modules.github.io/fsxt/functions/access.html)
-- [appendFile](https://uwx-node-modules.github.io/fsxt/functions/appendFile.html)
-- [copy](https://uwx-node-modules.github.io/fsxt/functions/copy.html)
-- [copyFile](https://uwx-node-modules.github.io/fsxt/functions/copyFile.html)
-- [cp](https://uwx-node-modules.github.io/fsxt/functions/cp.html)
-- [createReadStream](https://uwx-node-modules.github.io/fsxt/functions/createReadStream.html)
-- [createWriteStream](https://uwx-node-modules.github.io/fsxt/functions/createWriteStream.html)
-- [ensureFile](https://uwx-node-modules.github.io/fsxt/functions/ensureFile.html)
-- [exists](https://uwx-node-modules.github.io/fsxt/functions/exists.html)
-- [mkdir](https://uwx-node-modules.github.io/fsxt/functions/mkdir.html)
-- [mkdirs](https://uwx-node-modules.github.io/fsxt/functions/mkdirs.html)
-- [move](https://uwx-node-modules.github.io/fsxt/functions/move.html)
-- [open](https://uwx-node-modules.github.io/fsxt/functions/open.html)
-- [outputFile](https://uwx-node-modules.github.io/fsxt/functions/outputFile.html)
-- [outputJson](https://uwx-node-modules.github.io/fsxt/functions/outputJson.html)
-- [read](https://uwx-node-modules.github.io/fsxt/functions/read.html)
-- [readdir](https://uwx-node-modules.github.io/fsxt/functions/readdir.html)
-- [readFile](https://uwx-node-modules.github.io/fsxt/functions/readFile.html)
-- [readJson](https://uwx-node-modules.github.io/fsxt/functions/readJson.html)
-- [readLines](https://uwx-node-modules.github.io/fsxt/functions/readLines.html)
-- [readText](https://uwx-node-modules.github.io/fsxt/functions/readText.html)
-- [rename](https://uwx-node-modules.github.io/fsxt/functions/rename.html)
-- [rm](https://uwx-node-modules.github.io/fsxt/functions/rm.html)
-- [rmdir](https://uwx-node-modules.github.io/fsxt/functions/rmdir.html)
-- [stat](https://uwx-node-modules.github.io/fsxt/functions/stat.html)
-- [symlink](https://uwx-node-modules.github.io/fsxt/functions/symlink.html)
-- [truncate](https://uwx-node-modules.github.io/fsxt/functions/truncate.html)
-- [unlink](https://uwx-node-modules.github.io/fsxt/functions/unlink.html)
-- [watch](https://uwx-node-modules.github.io/fsxt/functions/watch.html)
-- [watchFile](https://uwx-node-modules.github.io/fsxt/functions/watchFile.html)
-- [write](https://uwx-node-modules.github.io/fsxt/functions/write.html)
-- [writeFile](https://uwx-node-modules.github.io/fsxt/functions/writeFile.html)
-- [writeJson](https://uwx-node-modules.github.io/fsxt/functions/writeJson.html)
-
-#### Less Commonly Used Async Methods
-
-- [chmod](https://uwx-node-modules.github.io/fsxt/functions/chmod.html)
-- [chown](https://uwx-node-modules.github.io/fsxt/functions/chown.html)
-- [close](https://uwx-node-modules.github.io/fsxt/functions/close.html)
-- [dive](https://uwx-node-modules.github.io/fsxt/functions/dive.html)
-- [emptyDir](https://uwx-node-modules.github.io/fsxt/functions/emptyDir.html)
-- [ensureLink](https://uwx-node-modules.github.io/fsxt/functions/ensureLink.html)
-- [ensureSymlink](https://uwx-node-modules.github.io/fsxt/functions/ensureSymlink.html)
-- [fchmod](https://uwx-node-modules.github.io/fsxt/functions/fchmod.html)
-- [fchown](https://uwx-node-modules.github.io/fsxt/functions/fchown.html)
-- [forEachChild](https://uwx-node-modules.github.io/fsxt/functions/forEachChild.html)
-- [fstat](https://uwx-node-modules.github.io/fsxt/functions/fstat.html)
-- [ftruncate](https://uwx-node-modules.github.io/fsxt/functions/ftruncate.html)
-- [futimes](https://uwx-node-modules.github.io/fsxt/functions/futimes.html)
-- [gracefulify](https://uwx-node-modules.github.io/fsxt/functions/gracefulify.html)
-- [isDirectory](https://uwx-node-modules.github.io/fsxt/functions/isDirectory.html)
-- [isSymlink](https://uwx-node-modules.github.io/fsxt/functions/isSymlink.html)
-- [~~lchmod~~](https://uwx-node-modules.github.io/fsxt/functions/lchmod.html)
-- [lchown](https://uwx-node-modules.github.io/fsxt/functions/lchown.html)
-- [`link`](https://uwx-node-modules.github.io/fsxt/functions/link.html)
-- [lstat](https://uwx-node-modules.github.io/fsxt/functions/lstat.html)
-- [lutimes](https://uwx-node-modules.github.io/fsxt/functions/lutimes.html)
-- [mapChildren](https://uwx-node-modules.github.io/fsxt/functions/mapChildren.html)
-- [mapStructure](https://uwx-node-modules.github.io/fsxt/functions/mapStructure.html)
-- [mapStructureOrdered](https://uwx-node-modules.github.io/fsxt/functions/mapStructureOrdered.html)
-- [mkdtemp](https://uwx-node-modules.github.io/fsxt/functions/mkdtemp.html)
-- [openAsBlob](https://uwx-node-modules.github.io/fsxt/functions/openAsBlob.html)
-- [opendir](https://uwx-node-modules.github.io/fsxt/functions/opendir.html)
-- [readv](https://uwx-node-modules.github.io/fsxt/functions/readv.html)
-- [realpath](https://uwx-node-modules.github.io/fsxt/functions/realpath.html)
-- [remove](https://uwx-node-modules.github.io/fsxt/functions/remove.html)
-- [resolve](https://uwx-node-modules.github.io/fsxt/functions/resolve.html)
-- [statfs](https://uwx-node-modules.github.io/fsxt/functions/statfs.html)
-- [unwatchFile](https://uwx-node-modules.github.io/fsxt/functions/unwatchFile.html)
-- [utimes](https://uwx-node-modules.github.io/fsxt/functions/utimes.html)
-- [vacuum](https://uwx-node-modules.github.io/fsxt/functions/vacuum.html)
-- [writev](https://uwx-node-modules.github.io/fsxt/functions/writev.html)
-
-### Sync
-
-#### Common Sync Methods
-
-- [accessSync](https://uwx-node-modules.github.io/fsxt/functions/accessSync.html)
-- [appendFileSync](https://uwx-node-modules.github.io/fsxt/functions/appendFileSync.html)
-- [copyFileSync](https://uwx-node-modules.github.io/fsxt/functions/copyFileSync.html)
-- [copySync](https://uwx-node-modules.github.io/fsxt/functions/copySync.html)
-- [cpSync](https://uwx-node-modules.github.io/fsxt/functions/cpSync.html)
-- [existsSync](https://uwx-node-modules.github.io/fsxt/functions/existsSync.html)
-- [mkdirSync](https://uwx-node-modules.github.io/fsxt/functions/mkdirSync.html)
-- [mkdirsSync](https://uwx-node-modules.github.io/fsxt/functions/mkdirsSync.html)
-- [moveSync](https://uwx-node-modules.github.io/fsxt/functions/moveSync.html)
-- [openSync](https://uwx-node-modules.github.io/fsxt/functions/openSync.html)
-- [outputFileSync](https://uwx-node-modules.github.io/fsxt/functions/outputFileSync.html)
-- [outputJsonSync](https://uwx-node-modules.github.io/fsxt/functions/outputJsonSync.html)
-- [readdirSync](https://uwx-node-modules.github.io/fsxt/functions/readdirSync.html)
-- [readFileSync](https://uwx-node-modules.github.io/fsxt/functions/readFileSync.html)
-- [readJsonSync](https://uwx-node-modules.github.io/fsxt/functions/readJsonSync.html)
-- [readTextSync](https://uwx-node-modules.github.io/fsxt/functions/readTextSync.html)
-- [renameSync](https://uwx-node-modules.github.io/fsxt/functions/renameSync.html)
-- [rmSync](https://uwx-node-modules.github.io/fsxt/functions/rmSync.html)
-- [rmdirSync](https://uwx-node-modules.github.io/fsxt/functions/rmdirSync.html)
-- [statSync](https://uwx-node-modules.github.io/fsxt/functions/statSync.html)
-- [symlinkSync](https://uwx-node-modules.github.io/fsxt/functions/symlinkSync.html)
-- [truncateSync](https://uwx-node-modules.github.io/fsxt/functions/truncateSync.html)
-- [unlinkSync](https://uwx-node-modules.github.io/fsxt/functions/unlinkSync.html)
-- [writeFileSync](https://uwx-node-modules.github.io/fsxt/functions/writeFileSync.html)
-- [writeJsonSync](https://uwx-node-modules.github.io/fsxt/functions/writeJsonSync.html)
-- [writeSync](https://uwx-node-modules.github.io/fsxt/functions/writeSync.html)
-
-#### Less Commonly Used Sync Methods
-
-- [chmodSync](https://uwx-node-modules.github.io/fsxt/functions/chmodSync.html)
-- [chownSync](https://uwx-node-modules.github.io/fsxt/functions/chownSync.html)
-- [closeSync](https://uwx-node-modules.github.io/fsxt/functions/closeSync.html)
-- [diveSync](https://uwx-node-modules.github.io/fsxt/functions/diveSync.html)
-- [emptyDirSync](https://uwx-node-modules.github.io/fsxt/functions/emptyDirSync.html)
-- [ensureFileSync](https://uwx-node-modules.github.io/fsxt/functions/ensureFileSync.html)
-- [ensureLinkSync](https://uwx-node-modules.github.io/fsxt/functions/ensureLinkSync.html)
-- [ensureSymlinkSync](https://uwx-node-modules.github.io/fsxt/functions/ensureSymlinkSync.html)
-- [fchmodSync](https://uwx-node-modules.github.io/fsxt/functions/fchmodSync.html)
-- [fchownSync](https://uwx-node-modules.github.io/fsxt/functions/fchownSync.html)
-- [fdatasync](https://uwx-node-modules.github.io/fsxt/functions/fdatasync.html)
-- [fdatasyncSync](https://uwx-node-modules.github.io/fsxt/functions/fdatasyncSync.html)
-- [forEachChildSync](https://uwx-node-modules.github.io/fsxt/functions/forEachChildSync.html)
-- [fstatSync](https://uwx-node-modules.github.io/fsxt/functions/fstatSync.html)
-- [fsync](https://uwx-node-modules.github.io/fsxt/functions/fsync.html)
-- [fsyncSync](https://uwx-node-modules.github.io/fsxt/functions/fsyncSync.html)
-- [ftruncateSync](https://uwx-node-modules.github.io/fsxt/functions/ftruncateSync.html)
-- [futimesSync](https://uwx-node-modules.github.io/fsxt/functions/futimesSync.html)
-- [isDirectorySync](https://uwx-node-modules.github.io/fsxt/functions/isDirectorySync.html)
-- [~~lchmodSync~~](https://uwx-node-modules.github.io/fsxt/functions/lchmodSync.html)
-- [lchownSync](https://uwx-node-modules.github.io/fsxt/functions/lchownSync.html)
-- [linkSync](https://uwx-node-modules.github.io/fsxt/functions/linkSync.html)
-- [lstatSync](https://uwx-node-modules.github.io/fsxt/functions/lstatSync.html)
-- [lutimesSync](https://uwx-node-modules.github.io/fsxt/functions/lutimesSync.html)
-- [mkdirsSync](https://uwx-node-modules.github.io/fsxt/functions/mkdirsSync.html)
-- [mkdtempSync](https://uwx-node-modules.github.io/fsxt/functions/mkdtempSync.html)
-- [opendirSync](https://uwx-node-modules.github.io/fsxt/functions/opendirSync.html)
-- [readLinesSync](https://uwx-node-modules.github.io/fsxt/functions/readLinesSync.html)
-- [readlinkSync](https://uwx-node-modules.github.io/fsxt/functions/readlinkSync.html)
-- [readSync](https://uwx-node-modules.github.io/fsxt/functions/readSync.html)
-- [readvSync](https://uwx-node-modules.github.io/fsxt/functions/readvSync.html)
-- [realpathSync](https://uwx-node-modules.github.io/fsxt/functions/realpathSync.html)
-- [removeSync](https://uwx-node-modules.github.io/fsxt/functions/removeSync.html)
-- [statfsSync](https://uwx-node-modules.github.io/fsxt/functions/statfsSync.html)
-- [utimesSync](https://uwx-node-modules.github.io/fsxt/functions/utimesSync.html)
-- [writevSync](https://uwx-node-modules.github.io/fsxt/functions/writevSync.html)
-
-## Bun Integration
-
-Relifso provides first-class support for Bun with automatic fallbacks to Node.js APIs. Here's how it works:
-
-### Automatic Runtime Detection
+#### `listFiles(path, options?)`
+
+Alias for `readdirRecursive`.
+
+#### `emptyDir(path, options?)`
+
+Remove all files and subdirectories from a directory.
+
+```ts
+await fs.emptyDir("temp");
+
+// With filter
+await fs.emptyDir("temp", {
+  filter: (path) => !path.includes("keep-me"),
+});
+```
+
+#### `remove(path, options?)`
+
+Remove a file or directory recursively.
 
 ```ts
-import { isBun } from "@reliverse/relifso";
+// Remove file
+await fs.remove("old-file.txt");
+
+// Remove directory
+await fs.remove("dist");
+
+// Force removal (ignore errors)
+await fs.remove("locked-dir", { force: true });
+```
+
+#### `pathExists(path)`
 
-if (isBun) {
-  console.log("Running in Bun!");
-} else {
-  console.log("Running in Node.js");
+Check if a path exists.
+
+```ts
+if (await fs.pathExists("config.json")) {
+  const config = await fs.readJson("config.json");
 }
 ```
 
-### Optimized File Operations
+#### `sizeOf(path, options?)`
 
-When running in Bun, relifso automatically uses Bun's optimized file system APIs:
+Get the total size of a file or directory.
 
-- `Bun.file()` for file operations
-- Native file existence checks
-- Optimized file size and type detection
-- Fast last modified time access
+```ts
+// File size
+const fileSize = await fs.sizeOf("large-file.zip");
 
-### Graceful Fallbacks
+// Directory size (recursive)
+const dirSize = await fs.sizeOf("node_modules");
 
-All Bun-specific operations include automatic fallbacks to Node.js APIs:
+// Follow symlinks
+const size = await fs.sizeOf("symlink", { followSymlinks: true });
+```
+
+### Copy & Move Operations
+
+#### `copy(source, destination, options?)`
+
+Copy a file or directory.
 
 ```ts
-import { getStats } from "@reliverse/relifso";
+// Copy file
+await fs.copy("src/index.ts", "dist/index.js");
 
-// In Bun: Uses Bun.file() for faster stats
-// In Node.js: Falls back to fs.stat()
-const stats = await getStats("file.txt");
+// Copy directory
+await fs.copy("src", "dist");
+
+// With options
+await fs.copy("src", "dist", {
+  overwrite: false, // Don't overwrite existing files
+  dereference: true, // Follow symlinks
+  filter: (path) => !path.includes("test"), // Filter files
+});
 ```
 
-### Available Bun-Specific Utilities
+#### `move(source, destination, options?)`
 
-- `getFile(path)` - Get a Bun file reference
-- `exists(path)` - Check file existence using Bun's API
-- `size(path)` - Get file size using Bun's API
-- `type(path)` - Get file MIME type using Bun's API
-- `lastModified(path)` - Get file last modified time
-- `getStats(path)` - Get file stats with Bun optimization
-- `getStatsSync(path)` - Synchronous version of getStats
+Move (rename) a file or directory.
 
-## Contributing
+```ts
+// Move file
+await fs.move("old.txt", "new.txt");
+
+// Move directory
+await fs.move("src", "lib");
+
+// With options
+await fs.move("old.txt", "new.txt", { overwrite: true });
+```
 
-...
+### Link Operations
 
-## TODO
+#### `ensureLink(source, destination)`
 
-- [x] Create usage example in [./example/e-relifso.ts](./e-relifso.ts) and [./example/e-pathkit.ts](./e-pathkit.ts)
-- [x] Ensure [./example/e-relifso.ts](./example/e-relifso.ts) and [./example/e-pathkit.ts](./example/e-pathkit.ts) works 100% correctly
-- [ ] Consider using [@reliverse/repath](https://github.com/reliverse/repath) instead of just `node:path`.
-- [ ] Pass all `fs-extra` tests with Bun (+ fix & improve them).
-- [ ] In [docs.reliverse.org](https://docs.reliverse.org) implement feature and performance comparison table with `fs-extra`.
+Create a hard link, ensuring the destination exists.
 
-## Shoutouts
+```ts
+await fs.ensureLink("original.txt", "link.txt");
+```
+
+#### `ensureSymlink(source, destination, options?)`
+
+Create a symbolic link, ensuring the destination exists.
+
+```ts
+// Unix/Linux/Mac
+await fs.ensureSymlink("target", "link");
+
+// Windows (automatic junction detection)
+await fs.ensureSymlink("target", "link", { type: "dir" });
+```
 
-Relifso wouldn't be so cool without these gems:
+### Utility Functions
 
-- [`node:fs`](https://nodejs.org/api/fs.html)+[`node:path`](https://nodejs.org/api/path.html) — origins
-- [`fs-extra`](https://github.com/jprichardson/node-fs-extra) — classic, reliable
-- [`fsxt`](https://github.com/uwx-node-modules/fsxt) — full fs-extra overhaul
+#### `touch(path, options?)`
 
-## Show Some Love
+Update file access and modification times, creating the file if it doesn't exist.
+
+```ts
+// Update to current time
+await fs.touch("file.txt");
+
+// Set specific times
+await fs.touch("file.txt", {
+  mtime: new Date("2024-01-01"),
+  atime: new Date("2024-01-01"),
+});
+```
+
+#### `readLines(path, options?)`
+
+Read a file and return its contents as an array of lines.
+
+```ts
+// Basic usage
+const lines = await fs.readLines("file.txt");
+
+// With options
+const lines = await fs.readLines("file.txt", {
+  trim: true, // Trim whitespace
+  skipEmpty: true, // Skip empty lines
+  maxLines: 100, // Limit number of lines
+});
+```
+
+## Performance
+
+This library is optimized for Bun's native file I/O APIs:
+
+- **`Bun.file().bytes()`** - Direct binary reading without conversion overhead
+- **`Bun.file().json()`** - Native JSON parsing
+- **`Bun.write()`** - Uses optimized syscalls (`copy_file_range`, `sendfile`, `clonefile`, `fcopyfile`)
+- **`Bun.file().exists()`** - Fast existence checks
+
+Run benchmarks:
+
+```bash
+bun run perf.ts
+```
+
+## Migration from fs-extra
+
+This library is designed as a drop-in replacement for the most commonly used `fs-extra` APIs:
+
+```ts
+// Before (fs-extra)
+import * as fs from "fs-extra";
+
+// After (@reliverse/relifso)
+import fs from "@reliverse/relifso";
+
+// API is identical for supported methods
+await fs.ensureDir("dist");
+await fs.copy("src", "dist");
+await fs.readJson("package.json");
+```
+
+**Note:** This library focuses on the most commonly used `fs-extra` methods. For less common APIs, you may need to use `node:fs` directly.
+
+## TypeScript Support
+
+Full TypeScript support with comprehensive type definitions:
+
+```ts
+import type {
+  CopyOptions,
+  FileEncoding,
+  ReadFileOptions,
+  WriteFileOptions,
+  JsonWriteOptions,
+} from "@reliverse/relifso";
+
+const options: CopyOptions = {
+  overwrite: true,
+  filter: (path) => path.endsWith(".ts"),
+};
+
+// Type-safe encoding
+const encoding: FileEncoding = "base64";
+const data = await fs.readFile("file.bin", { encoding });
+```
 
-If `@reliverse/relifso` reduced the number of lines in your codebase:
+## Requirements
 
-- ⭐ [Star it on GitHub](https://github.com/reliverse/relifso)
-- 💖 [Sponsor @blefnk](https://github.com/sponsors/blefnk)
-- 🧙 Recommend it to your dev friends
+- **Bun** >= 1.0 (recommended for optimal performance)
+- **Node.js** >= 18 (fallback to `node:fs` when Bun APIs aren't available)
 
 ## License
 
-[MIT](./LICENSE) © 2025 [Nazar Kornienko (blefnk)](https://github.com/blefnk)
+MIT