Node adapter

Works with Node.js, Bun and Deno.

Example

adapter.ts

import { makeAdapter } from '@livestore/adapter-node'

const adapter = makeAdapter({
  storage: { type: 'fs' },
  // or in-memory:
  // storage: { type: 'in-memory' },
  sync: { backend: makeWsSync({ url: 'ws://localhost:8787' }) },
  // To enable devtools:
  // devtools: { schemaPath: new URL('./schema.ts', import.meta.url) },
})

Resetting local persistence

During development you can instruct the adapter to wipe the locally persisted state and eventlog databases on startup:

reset-persistence.ts

import { makeAdapter } from '@livestore/adapter-node'
const resetPersistence = process.env.NODE_ENV !== 'production' && Boolean(process.env.RESET_LIVESTORE)

const adapter = makeAdapter({
  storage: { type: 'fs' },
  resetPersistence,
})

Caution

This will delete all local data for the given storeId and clientId. It only clears local persistence and does not reset any connected sync backend. Only enable it for debugging scenarios.

Worker adapter

The worker adapter can be used for more advanced scenarios where it’s preferable to reduce the load of the main thread and run persistence/syncing in a worker thread.

worker-main.ts

import { makeWorkerAdapter } from '@livestore/adapter-node'
const adapter = makeWorkerAdapter({
  storage: { type: 'fs' },
  workerUrl: new URL('./livestore.worker.js', import.meta.url),
})

worker-worker.ts schema.ts

import { makeWorker } from '@livestore/adapter-node/worker'
import { makeWsSync } from '@livestore/sync-cf/client'

import { schema } from './schema.ts'

makeWorker({
  schema,
  sync: { backend: makeWsSync({ url: 'ws://localhost:8787' }) },
})

import { defineMaterializer, Events, makeSchema, Schema, State } from '@livestore/livestore'

const tables = {
  todos: State.SQLite.table({
    name: 'todos',
    columns: {
      id: State.SQLite.text({ primaryKey: true }),
      text: State.SQLite.text(),
      completed: State.SQLite.boolean({ default: false }),
    },
  }),
} as const

const events = {
  todoCreated: Events.synced({
    name: 'v1.TodoCreated',
    schema: Schema.Struct({ id: Schema.String, text: Schema.String }),
  }),
} as const

const materializers = State.SQLite.materializers(events, {
  [events.todoCreated.name]: defineMaterializer(events.todoCreated, ({ id, text }) =>
    tables.todos.insert({ id, text, completed: false }),
  ),
})

const state = State.SQLite.makeState({ tables, materializers })

export const schema = makeSchema({ events, state })

Logging

You can control what the Node worker logs and how it’s formatted. Pass two optional options to makeWorker:

• logger — where/format of logs (e.g. pretty console output)
• logLevel — how verbose logs are ("None" silences logs)

worker-logging.ts schema.ts

import { makeWorker } from '@livestore/adapter-node/worker'
import { Logger } from '@livestore/utils/effect'

import { schema } from './schema.ts'

makeWorker({
  schema,
  // readable console output
  logger: Logger.layer([Logger.consolePretty()]),
  // choose verbosity: None | Error | Warn | Info | Debug
  logLevel: 'Info',
})

import { defineMaterializer, Events, makeSchema, Schema, State } from '@livestore/livestore'

const tables = {
  todos: State.SQLite.table({
    name: 'todos',
    columns: {
      id: State.SQLite.text({ primaryKey: true }),
      text: State.SQLite.text(),
      completed: State.SQLite.boolean({ default: false }),
    },
  }),
} as const

const events = {
  todoCreated: Events.synced({
    name: 'v1.TodoCreated',
    schema: Schema.Struct({ id: Schema.String, text: Schema.String }),
  }),
} as const

const materializers = State.SQLite.materializers(events, {
  [events.todoCreated.name]: defineMaterializer(events.todoCreated, ({ id, text }) =>
    tables.todos.insert({ id, text, completed: false }),
  ),
})

const state = State.SQLite.makeState({ tables, materializers })

export const schema = makeSchema({ events, state })

Tips:

• Use "None" to keep test output quiet.
• Keep the default (Debug) when diagnosing issues.