tona-db-mini

Summary

- Summary
- Explanation
- Installation
- Configuration
- Usages
- Basic Usage
- Add data to collection
- Get data from collection
- Update data in collection
- Delete data from collection
- Filters
- Compatibility
- Example in CommonJS

Explanation

Tona DB mini is a Node module written in TypeScript that provides the ability to store, update, and retrieve data persistently, much like a database would. It is designed to be simple to use and quick to set up, making it easy to integrate into a small project that requires data persistence without the need to implement a traditional and complex database.
Data is stored in JSON format, which makes it easy to manipulate and migrate between projects. The module simulates a non-relational database with a system of collections.
> Note: This project still under development. Many features are planned for future releases.

Installation

Simply run the following command to install the module from npm:

``shell
npm install tona-db-mini
`

Configuration


To configure the module, you can create a configuration file named tdb-mini.config.json in the root directory of your project. This file should contain the following properties:

`json
{
"dbPath": "./tdb-mini-data",
"prettyJson": false
}
`

- dbPath - The path to the database folder.
- prettyJson - A boolean value that determines whether the JSON data should be formatted with indentation.

Usages

$3


`ts
import db from "tona-db-mini";

// Create your type for your collection
type User = {
name: string;
age: number;
};

const users = db.collection("users");

// Add a new user
users.add({ name: "John Doe", age: 30 });

// Get user by name
const user = users.get({ name: "John Doe" });
`

$3


To add data to a collection, you can use the add method.
The add method takes an object or an array of objects as an argument.

`ts
import db from "tona-db-mini";

// Create your type for your collection
type User = {
name: string;
age: number;
};

const users = db.collection("users");

// Add a new user
users.add({ name: "John Doe", age: 30 });

// Add multiple users
users.add([{ name: "Jane Doe", age: 25 }, { name: "Bob Smith", age: 35 }]);
`

$3


To get data from a collection, you can use the get method.
The get method takes an Filter as an argument. If no filter is provided, it will return all data from the collection.

`ts
import db from "tona-db-mini";

// Create your type for your collection
type User = {
name: string;
age: number;
};

const users = db.collection("users");

// Get data from collection
const specificUser = users.get({ name: "John Doe" });

// Get all data from collection
const allUsers = users.get();
`

$3


To update data in a collection, you can use the update method.
The update method takes a Filter and a partial data object as arguments.

`ts
import db from "tona-db-mini";

// Create your type for your collection
type User = {
name: string;
age: number;
};

const users = db.collection("users");

// Update data in collection
users.update({ name: "John Doe" }, { age: 31 });
`




$3


To delete data from a collection, you can use the del method.
The del method takes an Filter as an argument. If no filter is provided, it will delete all data from the collection.

`ts
import db from "tona-db-mini";

// Create your type for your collection
type User = {
name: string;
age: number;
};

const users = db.collection("users");

// Delete data from collection
users.del({ name: "John Doe" });

// Delete all data from collection
users.del();
`

$3

You can use a filter to specify which data you want to get, update, or delete from a collection. The filter can be an object or a predicate function.

`ts
import db from "tona-db-mini";

// Create your type for your collection
type User = {
name: string;
age: number;
};

const users = db.collection("users");

// Get user with name "John Doe"
const specificUser = users.get({ name: "John Doe" });

// Get users with age greater than 30
const olderUsers = users.get((user) => user.age > 30);
`

Compatibility

Tona DB mini is a very flexible JavaScript/TypeScript module: it works in Node.js (backend, scripts, serverless), in Deno, with the older CommonJS format (require), and even with a TypeScript runtime like tsx without a build step. In short, it fits smoothly into most modern or existing stacks.

| Environment / stack | Supported? | Usage notes |
| ------------------------ | ---------- | --------------------------------------------- |
| Node.js | ✅ | Backend apps, scripts, serverless |
| Deno | ✅ | URL imports, secure runtime |
| CommonJS (require) | ✅ | No need to migrate to ES Modules |
| TS runtime (tsx) | ✅ | Run TypeScript directly, no build step needed |




$3

`js
const db = require("tona-db-mini").default;

const users = db.collection("users");

// Add a new user
users.add({ name: "John Doe", age: 30 });

// Get user by name
const user = users.get({ name: "John Doe" });
``