quymnydb

Official JavaScript / TypeScript client for the QuymnyDB worker API.

Installation

npm install quymnydb

Quick Start

import { QuymnyDB } from "quymnydb";

const db = new QuymnyDB({
  url: "https://qdb-worker.quymny.com/execute-sql",
  tokenKey: "YOUR_TOKEN_KEY"
});

// 1. Test connection
const ok = await db.connect();
console.log(ok ? "Connected ✓" : "Connection failed ✗");

// 2. Run a query
const result = await db.execute("SELECT * FROM dev_team;");
console.log(result);

API

new QuymnyDB({ url, tokenKey })

| Option | Type | Required | Description | |------------|----------|----------|--------------------------------------| | url | string | Yes | Worker endpoint URL | | tokenKey | string | Yes | Your authentication token |

await db.connect()

Performs a lightweight SELECT 1 to verify connectivity.
Returns true on success, false on failure.

await db.execute(query, params?)

Executes a SQL statement against the worker.

• query – SQL string (required)
• params – optional array or object of parameters

Returns the raw JSON response from the worker.

Example – Fetch team members

import { QuymnyDB } from "quymnydb";

const db = new QuymnyDB({
  url: "https://qdb-worker.quymny.com/execute-sql",
  tokenKey: process.env.QUYMNY_TOKEN || "YOUR_TOKEN_KEY"
});

async function main() {
  if (!(await db.connect())) {
    console.error("Could not connect to QuymnyDB");
    process.exit(1);
  }

  const res = await db.execute("SELECT * FROM dev_team;");
  console.log(JSON.stringify(res, null, 2));
}

main().catch(console.error);

Requirements

• Node.js ≥ 18 (native fetch)

License

MIT