@harmonixjs/quick-db

Simple and flexible Quick.db plugin for Harmonix Discord framework.

Installation

``bash
npm install @harmonixjs/quick-db quick.db better-sqlite3
`

Quick Start

`typescript
import { Harmonix } from "@harmonixjs/core";
import { DatabasePlugin } from '@harmonixjs/quick-db';

const bot = new Bot({
bot: {
id: "YOUR_BOT_CLIENT_ID",
token: "YOUR_BOT_TOKEN"
},
publicApp: true,
folders: {
commands: "./src/commands",
events: "./src/events",
components: "./src/components"
},
intents: [3249151],
plugins: [
new DatabasePlugin({
filePath: './data/database.sqlite'
})
]
});

// OR
bot.use(new DatabasePlugin({...}))

bot.start();
`

Usage

$3

`typescript
// types/User.ts
export interface User {
discordId: string;
username: string;
coins: number;
level: number;
}

// types/Guild.ts
export interface Guild {
guildId: string;
prefix: string;
language: string;
premium: boolean;
}
`

$3

`typescript
import { User } from './types';

// Create tables with your types
const users = bot.database.table('users');

// Everything is typed!
await users.set('user_123', {
discordId: '123',
username: 'John',
coins: 100,
level: 5,
});

const user = await users.get('user_123');
// user is typed as User | null
`

$3

`typescript
// Set
await users.set('user_123', { ... });

// Get
const user = await users.get('user_123');

// Get typed (returns null instead of undefined)
const user = await users.getTyped('user_123');

// Update partial
await users.update('user_123', { coins: 200 });

// Delete
await users.delete('user_123');

// Check existence
const exists = await users.exists('user_123');

// Count
const count = await users.count();

// Get all
const allUsers = await users.getAllTyped();

// Clear table
await users.clear();
`

$3

`typescript
// Find one
const richUser = await users.findOne(user => user.coins > 1000);

// Find many
const premiumGuilds = await guilds.findMany(guild => guild.premium === true);

// Filter and sort
const topUsers = (await users.getAllTyped())
.sort((a, b) => b.value.coins - a.value.coins)
.slice(0, 10);
`

API Reference

$3

#### Constructor
`typescript
new DatabasePlugin(config?: DatabasePluginConfig)
`

Config:
- filePath?: string - Database file path (default: ./data/database.sqlite)

#### Methods

table(name: string): Database
Create or get a typed table.

getTables(): string[]
List all created tables.

close(): Promise
Close all connections.

$3

#### Properties
- table: string - Table name

#### Methods

get(key: string): Promise
Get value from Quick.db.

set(key: string, value: T): Promise
Set value.

delete(key: string): Promise
Delete key.

update(key: string, updates: Partial): Promise
Update partial value.

exists(key: string): Promise
Check if key exists.

all(): Promise>
Get all entries.

findOne(predicate): Promise
Find one entry matching condition.

findMany(predicate): Promise>
Find all entries matching condition.

count(): Promise
Count entries.

clear(): Promise`
Clear entire table.

Philosophy

@harmonixjs/quick-db is intentionally minimal. It provides:
- ✅ Type-safe database access
- ✅ Simple API wrapping Quick.db
- ✅ Full flexibility

It does NOT provide:
- ❌ Pre-defined schemas (User, Guild, etc.)
- ❌ Complex ORM features
- ❌ Migrations or validators

You define your own types and logic. The plugin just makes Quick.db easier and type-safe.

License

MIT © HarmonixJS