Skip to content
API reference

API reference

The generated reference is in docs/api. It covers four modules:

  • @fungi.computer/watchdog: Watchdog.make, WatchdogRuntime, WatchdogOptions, WatchdogError, and the job, result and SQLite owner types with their Effect schemas.
  • @fungi.computer/watchdog/effect: makeRuntime, WatchdogRuntimeEffect and EffectWatchdogOptions. The Effect runtime also has readSettled(limit, afterSequence?) for paging through settled jobs.
  • @fungi.computer/watchdog/node-sqlite: fromNodeSqlite(database) for a caller-owned Node SQLite database. It returns NodeSqliteOwner; its NodeSqliteCursor provides toArray() and one(), which returns exactly one decoded row and throws for zero or multiple rows.
  • @fungi.computer/watchdog/d1: createD1Watchdog, prepareD1Admission, watchdogD1Schema and purgeD1Queues.
  • @fungi.computer/watchdog/postgres: createPostgresWatchdog, watchdogPostgresSchema and purgePostgresQueues.
Module
d1
effect
index
node-sqlite
postgres