indexeddb-fs
Advanced tools
An fs kind of library dedicated to the browser. indexeddb-fs is a module that allows you to store data in the browser using an API similar to that of Node's fs module. It works based on a browser database called IndexedDB.
Any other solutions I've found didn't work correctly. Problems I've found was about not enough validation and also directories were not being created.
npm install indexeddb-fs
import fs from 'indexeddb-fs';
await fs.createDirectory('files');
await fs.createDirectory('/files/private');
await fs.createDirectory('root/files/public');
console.log(await fs.isDirectory('root')); // true
console.log(await fs.isDirectory('files')); // true
console.log(await fs.isDirectory('/files/private')); // true
await fs.writeFile('files/public/file.txt', 'content');
console.log(await fs.isFile('files/public/file.txt')); // true
console.log(await fs.isDirectory('files/public/file.txt')); // false
await fs.removeDirectory(fs.rootDirectoryName);
import { createFs } from 'indexeddb-fs';
const fs = createFs({
databaseVersion: 'indexeddb version (default "1")',
objectStoreName: 'store name in indexeddb (default "files")',
rootDirectoryName: 'your root directory name (default "root") ',
databaseName: 'indexeddb database name (default "indexeddb-fs")',
});
Error object.The created object contains all configuration fields you have passed as a configuration. It is also the way you can get access to default values.
import { databaseName, databaseVersion, objectStoreName, rootDirectoryName } from 'indexeddb-fs';
fullPath: string]Promise<boolean>Example of usage:
await expect(exists('file.txt')).resolves.toBeFalsy();
await writeFile('file.txt', 'test');
await expect(exists('file.tx')).resolves.toBeFalsy();
await expect(exists('file.txt')).resolves.toBeTruthy();
await expect(exists('test/file.tx')).resolves.toBeFalsy();
await remove('file.txt');
await expect(exists('file.txt')).resolves.toBeFalsy();
fullPath: string]Promise<FileEntry<any> | DirectoryEntry>Example of usage:
const createdDirectory = await createDirectory('directory');
const createdDirectoryDetails = await details(createdDirectory.fullPath);
expect(createdDirectoryDetails.type).toEqual('directory');
expect(createdDirectoryDetails.name).toEqual('directory');
expect(createdDirectoryDetails.directory).toEqual('root');
expect(createdDirectoryDetails.fullPath).toEqual('root/directory');
Example result for FileEntry<any> type:
{
type: 'file',
name: 'file.txt',
directory: 'root',
data: 'test 2 content',
createdAt: 1626882161631,
fullPath: 'root/file.txt'
}
Example result for DirectoryEntry type:
{
isRoot: false,
directory: 'root',
type: 'directory',
name: 'directory',
createdAt: 1626882291087,
fullPath: 'root/directory'
}
fullPath: string]Promise<void>Example of usage:
await writeFile('file1.txt', 'test content');
await remove('file1.txt');
await expect(exists('file1.txt')).resolves.toBeFalsy();
fullPath: string]Promise<boolean>Example of usage:
await createDirectory('files');
await createDirectory('directories');
await expect(isFile('files')).resolves.toBeFalsy();
await expect(isFile('directories')).resolves.toBeFalsy();
await writeFile('file', 'content');
await expect(isFile('file')).resolves.toBeTruthy();
await writeFile('files/file', 'content');
await expect(isFile('files/file')).resolves.toBeTruthy();
fullPath: string]Promise<FileEntry<TData>>Example of usage:
const createdFile = await writeFile('file.txt', 'test 2 content');
const createdFileDetails = await fileDetails(createdFile.fullPath);
expect(createdFileDetails.type).toEqual('file');
expect(createdFileDetails.name).toEqual('file.txt');
expect(createdFileDetails.directory).toEqual('root');
expect(createdFileDetails.data).toEqual('test 2 content');
expect(createdFileDetails.fullPath).toEqual('root/file.txt');
Example result for FileEntry<TData> type:
{
type: 'file',
name: 'file.txt',
directory: 'root',
data: 'test 2 content',
createdAt: 1626882161631,
fullPath: 'root/file.txt'
}
fullPath: string, data: TData]Promise<FileEntry<TData>>data to the file, replacing the file if it already exists. data can be everything that you want.Example of usage:
await createDirectory('test2');
const result = await writeFile('file3.txt', { test: 'object' });
expect(result.type).toEqual('file');
expect(result.name).toEqual('file3.txt');
expect(result.directory).toEqual('root');
expect(result.data).toEqual({ test: 'object' });
expect(result.fullPath).toEqual('root/file3.txt');
Example result for FileEntry<TData> type:
{
type: 'file',
name: 'file.txt',
directory: 'root',
data: 'test 2 content',
createdAt: 1626882161631,
fullPath: 'root/file.txt'
}
fullPath: string]Promise<TData>Example of usage:
const file = await writeFile('file.txt', 'test 2 content');
await expect(readFile(file.fullPath)).resolves.toEqual('test 2 content');
fullPath: string]Promise<void>Example of usage:
await writeFile('file1.txt', 'test content');
await removeFile('file1.txt');
await expect(exists('file1.txt')).resolves.toBeFalsy();
fullPath: string, newFilename: string]Promise<FileEntry<TData>>fullPath to newFilename.fullPath is not a file.fullPath with a newFilename is already taken.Example of usage:
const writtenFile = await writeFile('test_file.txt', 'content');
const renamedFile = await renameFile('test_file.txt', 'renamed_file.txt');
await expect(exists('test_file.txt')).resolves.toBeFalsy();
await expect(exists('renamed_file.txt')).resolves.toBeTruthy();
expect(writtenFile.data).toEqual(renamedFile.data);
expect(writtenFile.type).toEqual(renamedFile.type);
expect(writtenFile.createdAt).toEqual(renamedFile.createdAt);
expect(writtenFile.directory).toEqual(renamedFile.directory);
Example result for FileEntry<TData> type:
{
type: 'file',
name: 'file.txt',
directory: 'root',
data: 'test 2 content',
createdAt: 1626882161631,
fullPath: 'root/file.txt'
}
fullPath: string]Promise<DirectoryEntry>fullPath and returns a Promise.Example result for DirectoryEntry type:
{
isRoot: false,
directory: 'root',
type: 'directory',
name: 'directory',
createdAt: 1626882291087,
fullPath: 'root/directory'
}
fullPath: string]Promise<DirectoryEntry>Example result for DirectoryEntry type:
{
isRoot: false,
directory: 'root',
type: 'directory',
name: 'directory',
createdAt: 1626882291087,
fullPath: 'root/directory'
}
fullPath: string]Promise<ReadDirectoryDecoratorOutput>Example result for ReadDirectoryDecoratorOutput type:
{
files: [],
filesCount: 0,
isEmpty: true,
directories: [],
directoriesCount: 0,
}
fullPath: string]Promise<boolean>fullPath: string]Promise<void>MIT
FAQs
An 'fs' kind of library dedicated to the browser
The npm package indexeddb-fs receives a total of 151 weekly downloads. As such, indexeddb-fs popularity was classified as not popular.
We found that indexeddb-fs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.