@probitas/client-deno-kv

Basic usage with in-memory database

import { createDenoKvClient } from "@probitas/client-deno-kv";

interface User {
  name: string;
  email: string;
}

const kv = await createDenoKvClient();

await kv.set(["users", "123"], { name: "Alice", email: "alice@example.com" });

const result = await kv.get<User>(["users", "123"]);
if (result.ok) {
  console.log(result.value);  // { name: "Alice", email: "alice@example.com" }
}

await kv.close();

Using persistent storage

import { createDenoKvClient } from "@probitas/client-deno-kv";

const kv = await createDenoKvClient({
  path: "./data.kv",
});

await kv.close();

Set with expiration (TTL)

import { createDenoKvClient } from "@probitas/client-deno-kv";

const kv = await createDenoKvClient();
const sessionId = "abc123";
const sessionData = { userId: "123", token: "xyz" };

await kv.set(["sessions", sessionId], sessionData, {
  expireIn: 3600_000,  // Expire in 1 hour
});

await kv.close();

List entries by prefix

import { createDenoKvClient } from "@probitas/client-deno-kv";

interface User {
  name: string;
  email: string;
}

const kv = await createDenoKvClient();

const result = await kv.list<User>({ prefix: ["users"] });
if (result.ok) {
  for (const entry of result.entries) {
    console.log(entry.key, entry.value);
  }
}

await kv.close();

Atomic transactions

import { createDenoKvClient } from "@probitas/client-deno-kv";

const kv = await createDenoKvClient();

const atomicResult = await kv.atomic()
  .check({ key: ["counter"], versionstamp: null })
  .set(["counter"], 1)
  .commit();

await kv.close();

Using await using for automatic cleanup

import { createDenoKvClient } from "@probitas/client-deno-kv";

await using kv = await createDenoKvClient();

await kv.set(["test"], "value");
// Client automatically closed when scope exits

Error handling with Failure pattern

import { createDenoKvClient } from "@probitas/client-deno-kv";

async function example() {
  const kv = await createDenoKvClient();

  const result = await kv.get<string>(["key"]);

  if (!result.ok) {
    if (!result.processed) {
      // Connection failure
      console.error("Connection failed:", result.error.message);
    } else {
      // KV error (quota exceeded, etc.)
      console.error("KV error:", result.error.message);
    }
    await kv.close();
    return;
  }

  console.log("Value:", result.value);
  await kv.close();
}

Using throwOnError for traditional exception handling

import { createDenoKvClient, DenoKvError } from "@probitas/client-deno-kv";

const kv = await createDenoKvClient({ throwOnError: true });

try {
  const result = await kv.get<string>(["key"]);
  console.log("Value:", result.value);
} catch (error) {
  if (error instanceof DenoKvError) {
    console.error("KV error:", error.message);
  }
}

await kv.close();