cromx-database-client
v1.0.2
Published
A db client for cromx database
Readme
📦 CromxDB
A simple and lightweight Node.js client for interacting with the CromxDB REST API.
🚀 Installation
npm install cromx-database-client🧠 Usage
const CromxDB = require("cromx-database-client");
const db = new CromxDB("your-database-id");
(async () => {
// Insert a document
await db.insertOne("users", { name: "John", age: 30 });
// Find documents
const users = await db.find("users", { age: 30 });
console.log(users);
})();🔧 API Reference
Each method requires:
- A collection name
- And optionally a query, filter, or document
🔍 Find
db.find(collection, query);Returns all documents matching the query.
🔍 Find One
db.findOne(collection, query);Returns the first matching document.
🔍 Find Many
db.findMany(collection, query);Returns multiple documents (same as find for now).
🔍 Find by ID
db.findById(collection, { id: "your id" });➕ Insert One
db.insertOne(collection, document);➕ Insert Many
db.insertMany(collection, [documents]);✏️ Update One
db.updateOne(collection, filter, update);✏️ Update Many
db.updateMany(collection, filter, update);❌ Delete One
db.deleteOne(collection, filter);❌ Delete Many
db.deleteMany(collection, filter);🧨 Drop Collection
db.dropCollection(collection);📌 Notes
- All operations are asynchronous and return Promises.
- Make sure to pass a valid CromxDB database ID when initializing.
🛡 License
MIT
✨ Author
Ibrahem Mohamed — Backend Engineer Feel free to contribute or suggest improvements!
