Skip to main content
Deno 2 is finally here 🎉️
Learn more

Kwik

Kwik is a deno database using messagepack files.

Examples

import { Kwik, KwikTable } from "./table.ts";

interface UserSchema {
    username: string,
    createdAt: Date
}

const kwik = new Kwik();
const users = new KwikTable<UserSchema>(kwik, "users");

await kwik.init();

const userId = kwik.uuid4();
await users.set(userId, {
    username: 'TriForMine',
    createdAt: new Date()
});
if (users.has(userId)) {
    const user = await users.get(userId);
    await users.delete(userId);
} else {
    console.error('An error occurred, the user was not added to the database.');
}

Message Pack Customization

Here is an example to setup custom extension types for msgpack

import { Kwik, KwikTable } from "./mod.ts";
import { encode, decode } from "https://esm.sh/@msgpack/msgpack/mod.ts";

const kwik = new Kwik();
const table = new KwikTable(kwik, "table");

// Add Map<T> supports
kwik.msgpackExtensionCodec.register({
    type: 1,
    encode: (object: unknown): Uint8Array => {
        if (object instanceof Map) {
            return encode([...object]);
        } else {
            return new Uint8Array(0);
        }
    },
    decode: (data: Uint8Array) => {
        const array = decode(data) as Array<[unknown, unknown]>;
        return new Map(array);
    },
});

await kwik.init();

await table.set('test', new Map<string, string>());