Moduletrace/bun-sqlite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Benjamin Toby 2026-03-02 14:59:54 +01:00
parent 310f14dd75
commit 83bc501bd1
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -79,8 +79,8 @@ import type { BunSQLiteConfig } from "@moduletrace/bun-sqlite";
const config: BunSQLiteConfig = { const config: BunSQLiteConfig = {
db_name: "my-app.db", db_name: "my-app.db",
db_schema_file_name: "schema.ts", db_schema_file_name: "schema.ts",
db_backup_dir: ".backups",
db_dir: "./db", // optional: where to store the db file db_dir: "./db", // optional: where to store the db file
db_backup_dir: ".backups", // optional: name of backups directory. Relative to the db dir.
typedef_file_path: "./db/types/db.ts", // optional: where to write generated types typedef_file_path: "./db/types/db.ts", // optional: where to write generated types
}; };
@ -152,10 +152,10 @@ await BunSQLite.delete({ table: "users", targetId: 1 });
The config file must be named `bun-sqlite.config.ts` and placed at the root of your project. The config file must be named `bun-sqlite.config.ts` and placed at the root of your project.
| Field | Type | Required | Description | | Field | Type | Required | Description |
| --------------------- | -------- | -------- | --------------------------------------------------------------------------------- | | --------------------- | -------- | -------- | ------------------------------------------------------------------------------------------ |
| `db_name` | `string` | Yes | Filename for the SQLite database (e.g. `"app.db"`) | | `db_name` | `string` | Yes | Filename for the SQLite database (e.g. `"app.db"`) |
| `db_schema_file_name` | `string` | Yes | Filename of the schema file relative to `db_dir` (or root if `db_dir` is not set) | | `db_schema_file_name` | `string` | Yes | Filename of the schema file relative to `db_dir` (or root if `db_dir` is not set) |
| `db_backup_dir` | `string` | Yes | Directory for database backups, relative to `db_dir` | | `db_backup_dir` | `string` | No | Directory for database backups, relative to `db_dir` |
| `db_dir` | `string` | No | Root directory for the database file and schema. Defaults to project root | | `db_dir` | `string` | No | Root directory for the database file and schema. Defaults to project root |
| `typedef_file_path` | `string` | No | Output path for generated TypeScript types, relative to project root | | `typedef_file_path` | `string` | No | Output path for generated TypeScript types, relative to project root |
| `max_backups` | `number` | No | Maximum number of backup files to keep. Oldest are deleted automatically. Defaults to `10` | | `max_backups` | `number` | No | Maximum number of backup files to keep. Oldest are deleted automatically. Defaults to `10` |

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "@moduletrace/bun-sqlite", "name": "@moduletrace/bun-sqlite",
"version": "1.0.3", "version": "1.0.4",
"description": "SQLite manager for Bun", "description": "SQLite manager for Bun",
"author": "Benjamin Toby", "author": "Benjamin Toby",
"main": "dist/index.js", "main": "dist/index.js",