Skip to main content

Quickstart

import { QLocalStorageEngine, StorageStore } from '@quik/storage';

const engine = new QLocalStorageEngine();
StorageStore.register(engine.name, engine);

const stored = await engine.new('uploads/hello.txt', Buffer.from('hello').toString('base64'), { fill: true });
const file = await engine.get('uploads/hello.txt');
const url = await file.getUrl();

Notes

There is no top-level getStorage() helper — engines are registered on StorageStore and used directly, or resolved with StorageStore.getDefault()/StorageStore.get(name).
read()/save() load entire contents into memory; use readStream()/saveStream() for large files.
Local storage paths are resolved relative to storage.local.destination unless you pass absolute paths.

Notes