API reference
api
API reference: api
API documentation is generated from each package's src/index.ts with TypeDoc and enriched with Fumadocs TypeScript type tables on package guide pages.
Each package index is titled with its npm scope (e.g. @melon-db/db), not a generic "Melon-db API".
Regenerate
From the monorepo root:
bun run --filter docs docs:apiPackages by layer
Core
| Package | Depends on | API index |
|---|---|---|
@melon-db/db | — | melon-db |
SQLite adapters
| Package | Depends on | API index |
|---|---|---|
@melon-db/db-sqlite | @melon-db/db | melon-db-sqlite |
@melon-db/db-sqlite-native | @melon-db/db-sqlite (peer) | melon-db-sqlite-native |
Query surfaces
| Package | Depends on | API index |
|---|---|---|
@melon-db/db-query | @melon-db/db | melon-db-query |
@melon-db/db-query-mango | @melon-db/db | melon-db-query-mango |
@melon-db/db-prisma | @melon-db/db | melon-db-prisma |
React and tooling
| Package | Depends on | API index |
|---|---|---|
@melon-db/db-react | @melon-db/db, query packages, @melon-db/sync | melon-db-react |
@melon-db/db-devtools | @melon-db/db | melon-db-devtools |
@melon-db/db-testkit | @melon-db/db | melon-db-testkit |
@melon-db/db-codemods | @melon-db/db | melon-db-codemods |
Sync
| Package | Depends on | API index |
|---|---|---|
@melon-db/sync | @melon-db/db | melon-sync |
@melon-db/sync-server | @melon-db/sync, @melon-db/db | melon-sync-server |
Only symbols exported from each package src/index.ts are included. Package guides under /docs/packages provide setup context and examples beyond the generated reference.