File System

What is the file system module?

fs is a small wrapper over the native file manager. Use it to read, write, remove, and check files. By default, every path resolves against the platform’s documents directory (the private, persistent folder where Unbound stores its data), so you can use short relative paths instead of absolute ones. fs is built on the native bridge. storage and i18n persist their data through it: when you call storage.set, fs is what eventually writes the value to disk.

import { fs } from '@unbound-app/api';

await fs.write('my-plugin/data.json', JSON.stringify({ count: 1 }));
const raw = await fs.read('my-plugin/data.json');

Reading & writing

read and write default to utf8 encoding. read resolves to the file’s contents, and write resolves once the file is on disk. If you need the absolute documents path, it’s in fs.Documents.

import { fs } from '@unbound-app/api';

await fs.write('my-plugin/notes.txt', 'hello');

const contents = await fs.read('my-plugin/notes.txt');
// contents === 'hello'

// Pass an encoding when you're not working with text.
await fs.write('my-plugin/icon.png', base64Data, 'base64');

Relative paths resolve against fs.Documents. To read a file elsewhere on disk, pass an absolute path and false as the inDocuments argument: fs.read('/abs/path', 'utf8', false).

Checking & removing

exists checks whether a file exists, and rm deletes it. Both resolve to a boolean.

import { fs } from '@unbound-app/api';

if (await fs.exists('my-plugin/data.json')) {
	await fs.rm('my-plugin/data.json');
}

For configuration, use storage instead. Use fs directly when an addon ships its own data files, such as caches, exports, or downloaded assets, that don’t belong in the settings store.

Addons

Plugins

Themes

Icon Packs

Development

API Reference

Loader

What is the file system module?

Reading & writing

Checking & removing

​What is the file system module?

​Reading & writing

​Checking & removing

What is the file system module?

Reading & writing

Checking & removing