Skip to Content
Introduction

Vooya FS

Vooya FS is a Rust-powered execution engine for batch filesystem work in Node.js. It continues the former Rush-FS project under the Vooya name, with a narrower and focused promise: keep familiar Node APIs and prioritize native optimizations where substantial I/O, recursive or fused work can amortize the boundary cost.

API documentation version: 0.1.1. Install @vooya/fs@0.1.1 from npm. Benchmark reports retain their source-build revisions and measurement limits. Install the release or try main.

Start here

中文介绍与源码构建说明 。 本站 API 文档以英文为主，描述已发布的 0.1.1 版本；npm 版本的安装与支持平台请见 Quick Start。

One boundary, one batch

Node application
  ├─ tiny / one-off filesystem call ─────────────── node:fs
  └─ recursive or combined workload
                    │ one Node-API call
                    ▼
             Rust traversal engine
                    │ walk · filter · metadata · I/O
                    ▼
               one batched result

That means Vooya FS is a good candidate for repository indexing, build-tool input discovery, cache cleanup, package scanning, and large recursive copy/removal. It is usually not the right tool for an isolated existsSync or a tiny directory.

Start with a fused scan

import { scan } from '@vooya/fs'
 
const sources = await scan('./packages', {
  include: ['**/*.{ts,tsx,rs}'],
  exclude: ['**/node_modules/**', '**/dist/**'],
  skipHidden: true,
  concurrency: 4,
})

scan walks, filters, and collects metadata inside one native task. It is a Vooya FS extension; compatibility-oriented operations such as readdir, glob, cp, and rm remain available separately.

On the local Apple M4 Pro / Node 22.22 development fixture, scan processed 2,728 files and 341 directories in about 10.7 ms, versus 34.0 ms for recursive Node readdir plus per-entry lstat. On the 8-file fixture Node was faster. Read Benchmarks for the method and scale boundary.

Where it fits

Last updated on
Quick Start