How typicode/lowdb works
lowdb is a type-safe embedded JSON database for Node.js and browsers. A caller creates a database through a preset or pairs a Low/LowSync instance with an adapter, reads data, mutates the plain JavaScript value, then writes or calls update. Storage options include memory, browser storage, and Node files; Node’s DataFile layer supports custom serialization through TextFile. The graph follows documented behavior and sampled source; unsampled capabilities are represented only where the README supports them.
Main entry points: Low.ts Low / LowSync · node.ts Node Presets · browser.ts Browser Presets · WebStorage.ts WebStorage Adapter
Components 15
Database API
- Low / LowSync
src/core/Low.ts
Convenience Presets
- Node Presets
src/presets/node.ts - Browser Presets
src/presets/browser.ts
Storage Adapters
- Memory Adapter
src/adapters/Memory.ts - WebStorage Adapter
src/adapters/browser/WebStorage.ts - LocalStorage Adapter
src/adapters/browser/LocalStorage.ts - SessionStorage Adapter
src/adapters/browser/SessionStorage.ts
Node File Layers
- JSON File Adapter
src/adapters/node/JSONFile.ts - DataFile Adapter
src/adapters/node/DataFile.ts - TextFile Adapter
src/adapters/node/TextFile.ts
Other components
- Application
- Browser Storage
- Local Filesystem
- Atomic Writer
- Custom Formats
Connections 21
- Application → Node Presets: creates via
README.md - Application → Browser Presets: creates via
README.md - Application → Low / LowSync: reads and updates
README.md - Node Presets → Low / LowSync: constructs and reads
src/presets/node.ts - Browser Presets → Low / LowSync: constructs and reads
src/presets/browser.ts - Node Presets → Memory Adapter: selects in tests
src/presets/node.ts - Node Presets → JSON File Adapter: selects otherwise
src/presets/node.ts - Browser Presets → LocalStorage Adapter: constructs
src/presets/browser.ts - Browser Presets → SessionStorage Adapter: constructs
src/presets/browser.ts - Low / LowSync → Memory Adapter: reads and writes
src/core/Low.ts - Low / LowSync → WebStorage Adapter: reads and writes
src/core/Low.ts - Low / LowSync → JSON File Adapter: reads and writes
src/core/Low.ts - LocalStorage Adapter → WebStorage Adapter: extends
src/adapters/browser/LocalStorage.ts - SessionStorage Adapter → WebStorage Adapter: extends
src/adapters/browser/SessionStorage.ts - WebStorage Adapter → Browser Storage: gets and sets values
src/adapters/browser/WebStorage.ts - JSON File Adapter → DataFile Adapter: configures serialization
src/adapters/node/JSONFile.ts - DataFile Adapter → TextFile Adapter: reads and writes text
src/adapters/node/DataFile.ts - TextFile Adapter → Local Filesystem: reads and writes files
src/adapters/node/TextFile.ts - TextFile Adapter → Atomic Writer: uses async writer
src/adapters/node/TextFile.ts - Application → Custom Formats: may provide
README.md - Custom Formats → DataFile Adapter: supplies parse and stringify
README.md