TFS

The drop in Filer replacement you’ve been waiting for. Completely Typed and Built with TypeScript

Usage

Initializing TFS is slightly different than Filer. Below are the instructions on how to get TFS running.

First, either get the static files from the github releases or you can download TFS via the npm package at @terbiumos/tfs.

If your working with Vite, Express, etc to host the files you can import the web compiled files for TFS via the tfsPath import

import { tfsPath } from "@terbiumos/tfs";
// tfsPath is the path of the web folder of the TFS files

Aditionally, All of the classes are also typed and can be imported as such if needed:

import { FSType } from "@terbiumos/tfs";
// Types for tfs.fs

If you do not wish to host the files and use it directly in your code you can import the TFS class directly however you MUST use @terbiumos/tfs/browser for this import:

import { TFS } from "@terbiumos/tfs/browser";

const { fs } = await tfs.init();

The TFS Object consists of: FS, Path, Shell, and Buffer. The Buffer utility is actually the same as Filer and is powered by the Ferros Buffer Library with the same exact syntax as node:buffer and Filer.Buffer

To load TFS conviently, simply run:

const tfs = await tfs.init()

If you need a specific module from TFS, you can desctructure the object for the one that you need

const { fs } = await tfs.init()

If your working in a non asyncronous workspace or a service worker, you can use tfs.initSw() to initialize the TFS object on window (or in service worker contexts, self) automatically:

Or if you do not wish to use one of the following methods to initialize TFS, you can also use the constructor as normal;

const handle = await navigator.storage.getDirectory();
const tfs = new tfs(handle);

The TFS Shell works slightly different than the Filer Shell, it is already instantiated so you do not need to create a new instance of the Shell and you can directly call it as:

const shell = tfs.shell

const shell = tfs.fs.shell

however, if your lazy or are using some kind of compatability layer and still want the 1 to 1 support, TFS provides tfs.sh as a uninitialized shell however this isnt recommended.

As for the actual FS Usage, it remains the same as Filer which targets a node:fs like syntax

Contributing

Contributions are always welcome! Feel free to make a PR to help advance this project even further as its not just intended for Terbium use but also for use in projects that already rely on Filer for storage

If you find a security vulnerability, please contact [email protected] and DO NOT report it in the github issues space.

Also, Please make sure that the CI passes before you create your PR as it makes life easier for everyone/

Credits

Libraries Used

• Ferros Buffer Library - MIT License
• Minimatch - ISC License
• stack-trace - MIT License

Made with ❤️ By the Terbium Development Team

© Copyright 2025 TerbiumOS Development

Licensed Under the Apache 2.0 License