@harmonixjs/quick-db

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

Installation

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

Quick Start

import{Harmonix}from"@harmonixjs/core";import{DatabasePlugin}from'@harmonixjs/quick-db';constbot=newHarmonix({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: [newDatabasePlugin({filePath: './data/database.sqlite'})]});bot.start();

Usage

Define your own types

// types/User.tsexportinterfaceUser{discordId: string;username: string;coins: number;level: number;}// types/Guild.tsexportinterfaceGuild{guildId: string;prefix: string;language: string;premium: boolean;}

Create typed tables

import{User}from'./types';// Create tables with your typesconstusers=bot.plugins.database.table<User>('users');// Everything is typed!awaitusers.set('user_123',{discordId: '123',username: 'John',coins: 100,level: 5,});constuser=awaitusers.get('user_123');// user is typed as User | null

Basic Operations

// Setawaitusers.set('user_123',{ ... });// Getconstuser=awaitusers.get('user_123');// Get typed (returns null instead of undefined)constuser=awaitusers.getTyped('user_123');// Update partialawaitusers.update('user_123',{coins: 200});// Deleteawaitusers.delete('user_123');// Check existenceconstexists=awaitusers.exists('user_123');// Countconstcount=awaitusers.count();// Get allconstallUsers=awaitusers.getAllTyped();// Clear tableawaitusers.clear();

Advanced Queries

// Find oneconstrichUser=awaitusers.findOne(user=>user.coins>1000);// Find manyconstpremiumGuilds=awaitguilds.findMany(guild=>guild.premium===true);// Filter and sortconsttopUsers=(awaitusers.getAllTyped()).sort((a,b)=>b.value.coins-a.value.coins).slice(0,10);

API Reference

DatabasePlugin

Constructor

newDatabasePlugin(config?: DatabasePluginConfig)

Config:

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

Methods

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

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

close(): Promise<void>
Close all connections.

Database<T>

Properties

• table: string - Table name

Methods

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

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

delete(key: string): Promise<number>
Delete key.

update(key: string, updates: Partial<T>): Promise<T | null>
Update partial value.

exists(key: string): Promise<boolean>
Check if key exists.

all(): Promise<Array<{ id: string; value: T }>>
Get all entries.

findOne(predicate): Promise<T | null>
Find one entry matching condition.

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

count(): Promise<number>
Count entries.

clear(): Promise<void>
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