@trailhead/fs

Filesystem operations with Result-based error handling

Complete filesystem operations with Result-based error handling, built-in JSON support, and mock filesystem for testing.

Installation

pnpm add @trailhead/fs

Quick Example

import { fs } from '@trailhead/fs'

// Read a file
const result = await fs.readFile('./config.json')
if (result.isOk()) {
  console.log('File contents:', result.value)
}

// JSON operations
const config = await fs.readJson('./config.json')
await fs.writeJson('./data.json', { name: 'My App' })

// Directory operations
await fs.ensureDir('./logs/2024')
await fs.copy('./source', './destination')
await fs.move('./old.txt', './new.txt')

Key Features

• Result-based - Explicit error handling for all filesystem operations
• Complete coverage - Read, write, copy, move, remove operations
• JSON support - Built-in JSON reading and writing
• Mock filesystem - Testing utilities with in-memory filesystem
• Path utilities - Helper functions for path manipulation

Documentation

• API Documentation - Complete API reference
• File Operations Basics - Tutorial
• Perform Atomic Operations - How-to guide

License

MIT © Esteban URL