@thi.ng/file-io

This is one of 217 standalone projects. LLM-free, human-made and cared for software, maintained as part of the @thi.ng/umbrella ecosystem and anti-framework.

Please help me to work full-time on these projects by sponsoring me. Thank you!

• About
• Available functions
  • Files
  • Directories
  • Logging
• Status
• Installation
• Dependencies
• Usage examples
• API
• Authors
• License

About

Assorted file I/O utils (w/ logging support) for NodeJS/Bun.

Most functions in this package have optional support for the ILogger logging interface.

Available functions

Files

• bufferHash
• copyFile
• copyFileAsync
• createTempFile
• deleteFile
• deleteFileAsync
• deleteFiles
• deleteFilesAsync
• files
• fileChunks
• fileExt
• fileHash
• fileWatcher
• readBinary
• readBinaryAsync
• readJSON
• readJSONAsync
• readText
• readTextAsync
• streamHash
• tempFilePath
• writeFile
• writeFileAsync
• writeJSON
• writeJSONAsync
• writeText
• writeTextAsync

Directories

• deleteDir
• dirs
• ensureDir
• ensureDirForFile
• isDirectory

Logging

• maskedPath
• addPathMask
• setPathMasks

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/file-io

ESM import:

import * as fio from "@thi.ng/file-io";

For Node.js REPL:

const fio = await import("@thi.ng/file-io");

Package sizes (brotli'd, pre-treeshake): ESM: 2.50 KB

Dependencies

• @thi.ng/api
• @thi.ng/checks
• @thi.ng/hex
• @thi.ng/logger
• @thi.ng/random

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

Usage examples

One project in this repo's /examples directory is using this package:

Screenshot	Description	Live demo	Source
	CLI util to visualize umbrella pkg stats		Source

API

Generated API docs

TODO

Authors

• Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-file-io,
  title = "@thi.ng/file-io",
  author = "Karsten Schmidt",
  note = "https://thi.ng/file-io",
  year = 2022
}

License

2022 - 2026 Karsten Schmidt // Apache License 2.0