Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Database
✓ import { Database } from 'quickmongo'
✗ const Database = require('quickmongo')
The package is ESM-only since v5. Use named import for 'Database'.
MongoDriver
✓ import { MongoDriver } from 'quickmongo'
✗ const { MongoDriver } = require('quickmongo')
ESM-only import; used with quick.db for MongoDB backend.
default import
✓ import QuickMongo from 'quickmongo'
✗ const qm = require('quickmongo')
Default export is the 'Database' class; equivalent to import { Database }.
QuickMongo (TypeScript)
✓ import { Database } from 'quickmongo'; const db: Database = ...
✗ import Database from 'quickmongo'
TypeScript users should use type annotation with the Database type, but default import works too.
Shows how to connect, set, get, push, add, and use TTL with QuickMongo's Database class.
import { Database } from 'quickmongo';
const db = new Database(process.env.MONGO_URI ?? 'mongodb://localhost:27017/mydb');
db.on('ready', () => {
console.log('Connected to database');
});
await db.connect();
await db.set('user', { name: 'Alice', balance: 100 });
const user = await db.get('user');
console.log(user); // { name: 'Alice', balance: 100 }
await db.push('user.items', 'sword');
await db.add('user.balance', 50);
const balance = await db.get('user.balance');
console.log(balance); // 150
// TTL: auto-delete after 10 seconds
await db.set('temp', 'value', 10);
setTimeout(async () => {
const val = await db.get('temp');
console.log(val); // null
}, 11000);
Errors
Common errors & fixes
Cannot find module 'quickmongo'
Package not installed or import path incorrect (e.g., using require in ESM-only version).
fixRun: npm install quickmongo; for v5, use import instead of require.
MongooseError: The `uri` parameter to `openUri()` must be a string, got "undefined"
Database instance created without a connection URI.
fixPass a valid MongoDB URI: new Database('mongodb://...') TypeError: db.set is not a function
Database not connected; or using wrong import (e.g., default import vs named).
fixAwait db.connect() before operations; ensure correct import: import { Database } from 'quickmongo'. MongoDB connection error: MongooseServerSelectionError: connect ECONNREFUSED
MongoDB server not running or URI is wrong (port/host).
fixStart MongoDB service or check connection string. Use mongodb://localhost:27017 as default.
Audit
Dependencies
mongooserequiredUsed for MongoDB connection and operations; quickmongo does not bundle its own driver.