Skip to content

Files

Latest commit

55987d5 · Mar 9, 2025

History

History

file-io

@thi.ng/file-io

npm version npm downloads Mastodon Follow

Note

This is one of 203 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

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

About

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

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

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.05 KB

Dependencies

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

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 - 2025 Karsten Schmidt // Apache License 2.0