OmniStorage v1 Legacy Documentation

Docs Playground GitHub

Legacy documentation: this page documents OmniStorage v1. For new projects, use OmniStorage v2.

Introduction

Overview Installation

Core

Storage Engines

LocalStorage SessionStorage Cookies Cache Storage IndexedDB In-Memory File System SQLite Server SQLite WASM

Engine Guide Exports & Interfaces

API Reference

Configuration

init(options) db(name) use(engineType) engine(engineType) namespace(name) command(payload)

Write operations

create(key, value) save(key, value) update(key, value)

Read operations

find(key) findAll() findMany(keys)

Batch operations

saveMany(items) createMany(items) updateMany(items) destroyMany(keys)

Delete operations

destroy(key) truncate()

Advanced features

watch(key, callback) on(event, callback) transaction(callback) describe(key) getStatistics() getActivityLogs()

Logs & Statistics

Configuration

configureLogs(config) getLogConfig()

Activity logs

getActivityLogs(limit) getLogs(limit) clearActivityLogs()

Statistics

getStatistic(engineName) getStatistics() Statistics aliases

Examples

Use Cases

Authentication Preferences Multi-Tab Sync Shopping Cart API Cache Form Draft Cookie Consent Server Settings Audit Log Browser SQLite JSON Command Runner Testing