Deno Keyv

Keyv is a simple and lightweight, easy to use database wrapper made for the Javascript runtime envoirement, Deno. The wrapper is designed for quick setup and fast results.

Why Keyv?

Simple and easy to use.
Very fast results
Data doesnt disappear after restarts
Beginner Friendly
Supports dot notation. And much more!

Usage

Stable import { DB } from "https://deno.land/x/mod.ts";
Main import { DB } from "https://raw.githubusercontent.com/CyberKnight007/deno-keyv/main/mod.ts"; Main may contain bugs

Examples

import { DB } from "https://deno.land/x/keyv/mod.ts";

// Need to make a new file called `db.sqlite` in your folder.
// The second value is the name of the database.. You can name is anything you want
const db = new DB("db.sqlite", "userinfo");

// Important line to write before doing any operations!
await db.init();

// Set an object in the database.
//            Key           Value
await db.set("user", { name: "Alex" });
// Data -> 'user': { 'name': 'Alex' }

await db.set("user.gender", "male");
// Data -> 'user': { 'name': 'Alex', 'gender': 'male' }

await db.set("user.age", 33);
// Data -> 'user': { 'name': 'Alex', 'gender': 'male', 'age': 33}

// Getting the data from the database
const data = await db.get("user");
console.log(data);
// Output -> { 'name': 'Alex', 'gender': 'male', 'age': 33}

const age = await db.get("user.age");
console.log(age);
// Output -> 33

Docs

View Documentation here

Support

If you need help regarding the wrapper, feel free to open a issue or ask in the Help discussions category on github. You can also DM me on discord Tejas#9134.

Contributing

Pull Requests are always welcome. Just make sure to open a issue and inform us what you are working so that we can confirm if we want it in the repository or not.

We use deno fmt for formatting our files. We recommend you use it too if you wish to contribute.
Please do not add any more third party modules to the library without confirming with us first.