ObjectStackObjectStack

Driver Memory

Driver Memory protocol schemas

Memory Driver Configuration Schema

Defines the configuration options for the in-memory driver. Reference: objectql/packages/drivers/memory (Mingo-powered production-ready driver)

The memory driver is ideal for:

  • Unit testing (no database setup required)
  • Development & prototyping
  • Edge/Worker environments (Cloudflare Workers, Deno Deploy)
  • Client-side state management
  • Temporary data caching
  • CI/CD pipelines

Source: packages/spec/src/data/driver/memory.zod.ts

TypeScript Usage

import { AutoPersistenceConfigSchema, FilePersistenceConfigSchema, LocalStoragePersistenceConfigSchema, PersistenceTypeSchema } from '@objectstack/spec/data';
import type { AutoPersistenceConfig, FilePersistenceConfig, LocalStoragePersistenceConfig, PersistenceType } from '@objectstack/spec/data';

// Validate data
const result = AutoPersistenceConfigSchema.parse(data);

AutoPersistenceConfig

Auto-detect persistence configuration

Properties

PropertyTypeRequiredDescription
type'auto'
pathstringoptionalFile path override for Node.js environments
autoSaveIntervalnumberoptionalAuto-save interval override for Node.js environments
keystringoptionallocalStorage key override for browser environments

FilePersistenceConfig

File-system persistence configuration

Properties

PropertyTypeRequiredDescription
type'file'
pathstringoptionalFile path to persist data
autoSaveIntervalnumberoptional (default: 2000)Auto-save interval in ms

LocalStoragePersistenceConfig

localStorage persistence configuration

Properties

PropertyTypeRequiredDescription
type'local'
keystringoptionallocalStorage key for persisted data

PersistenceType

Persistence backend type

Allowed Values

  • file
  • local
  • auto

On this page