!@thi.ng/file-io

![npm version](https://www.npmjs.com/package/@thi.ng/file-io)
!npm downloads
![Mastodon Follow](https://mastodon.thi.ng/@toxi)

> [!NOTE]
> This is one of 214 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
- 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

Status

STABLE - used in production

Search or submit any issues for this package

Installation

``bash yarn add @thi.ng/file-io`

ESM import:

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

For Node.js REPL:

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

Package sizes (brotli'd, pre-treeshake): ESM: 2.44 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 |