Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roonie007/dongoose
Dongoose is a simple ( but intelligent ), lightweight, and easy to use ORM for Deno KV. It is written in Typescript and is inspired by Mongoose.
https://github.com/roonie007/dongoose
Last synced: 3 months ago
JSON representation
Dongoose is a simple ( but intelligent ), lightweight, and easy to use ORM for Deno KV. It is written in Typescript and is inspired by Mongoose.
- Host: GitHub
- URL: https://github.com/roonie007/dongoose
- Owner: roonie007
- License: mit
- Created: 2023-07-02T05:27:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-10T22:18:49.000Z (over 1 year ago)
- Last Synced: 2024-06-13T00:18:37.017Z (5 months ago)
- Language: TypeScript
- Size: 9.77 KB
- Stars: 21
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-deno - dongoose - A simple and easy to use ORM for Deno KV. (Modules / Database)
README
# Dongoose
Dongoose is a simple ( but intelligent ), lightweight, and easy to use ORM for Deno KV. It is written in Typescript and is inspired by Mongoose.
## Features
- 📄 **Schema** - Dongoose leverages Zod for easy data structuring and validation through a simple schema API.
- 🔍 **Indexes** - Dongoose enables automatic data insertion, update, and deletion through defined indexes.
- ✔️ **Validation** - Dongoose validates data before inserting or updating it using Zod.
- ⏰ **Timestamps** - Dongoose automatically adds timestamps to your data ( createdAt, updatedAt ).
- 📝 **Typescript** - Dongoose is written in Typescript and provides type definitions for all of its methods.
- 🍃 **Lightweight** - Dongoose is very lightweight and has no dependencies other than Zod.
- 👍 **Easy to use** - Dongoose is very easy to use and has a simple API.
- 💯 **Coverage** - Dongoose has 100% test coverage.
### Coming soon
- 🔗 **Relations** - Dongoose will soon support relations between collections.
- 🪝 **Hooks** - Dongoose will soon support hooks for pre and post operations.
- 💰 **Transactions** - Dongoose will soon support transactions.
- ➕ **More** - Dongoose will soon support more features.
## Usage
```typescript
import { d, Dongoose } from "https://deno.land/x/dongoose/mod.ts";
const db = await Deno.openKv();
const users = Dongoose(
{
email: d.string().email(),
username: d.string(),
password: d.string().min(8).max(32),
firstname: d.string().optional(),
lastname: d.string().optional(),
},
{
db, // Your Deno KV intance
name: "users", // Your collection name
indexes: ["email", "username"],
}
);
await users.create({
email: "[email protected]",
username: "Emmet",
password: "Homenick",
});
const user = await users.findOne({ email: "[email protected]" });
const _sameUserWithId = await users.findById(user!.id);
await users.updateById(user.id, { firstname: "John" });
await users.deleteById(user.id);
```
## How it works
Dongoose uses Zod to validate data before inserting or updating it. It also uses Zod to create a schema for your data. Dongoose uses the schema to automatically add timestamps to your data and to automatically insert, update, and delete data through defined indexes.
### Indexes
Let's say you have a collection of users and you want to be able to find a user by their `email` or `username`. You can define indexes for your collection like this:
```typescript
const users = Dongoose(
{
email: d.string().email(),
username: d.string(),
firstname: d.string().optional(),
lastname: d.string().optional(),
},
{
db,
name: "users", // Your collection name
indexes: ["email", "username"],
}
);
```
Upon user creation, update or delete, your data will be automatically inserted, updated or delete into/from these indexes: `["users_by_id", USER_ID]`, `["users_by_email", USER_EMAIL]`, and `["users_by_username", USER_EMAIL]`.
### Timestamps
Dongoose automatically adds timestamps to your data ( `createdAt`, `updatedAt` ) upon user creation or update.
## API
### Dongoose
```typescript
Dongoose(schema, options);
```
#### options
```typescript
{
db: KVStore;
name: string;
indexes?: string[];
}
```
### create
```typescript
await users.create({
email: "[email protected]",
username: "Emmet",
});
```
### findOne
```typescript
await users.findOne({ email: "[email protected]" });
```
### findById
```typescript
await users.findById("076520f1-cbf1-4e29-8af5-d6db8c851371");
```
### updateOne
```typescript
await users.updateOne({ username: "Emmet" });
```
### updateById
```typescript
await users.updateById("076520f1-cbf1-4e29-8af5-d6db8c851371", {
username: "garrett.guzman",
});
```
### deleteOne
```typescript
await users.deleteOne({ username: "Emmet" });
```
### deleteById
```typescript
await users.deleteById("076520f1-cbf1-4e29-8af5-d6db8c851371");
```
## License
Dongoose is licensed under the MIT license. See [LICENSE](LICENSE) for more information.