Deno Storage Area

An implementation of the StorageArea (1,2,3) interface for Deno with an extensible system for supporting various database backends.

The goal of this class is ease of use and compatibility with other Storage Area implementations, such as kv-storage-polyfill.

While work on the specification itself has stopped, KV Storage is still a good interface for asynchronous data access that feels native to JavaScript.

Example

// file: "mod.ts"
import { StorageArea } from 'https://deno.land/x/kv_storage/sqlite.ts';

const storage = new StorageArea();

await storage.set(['a', 3, new Date(0)], { 
  foo: 'bar',
  fizz: new Set(['buzz']),
  xyz: new Uint8Array([255]),
});

console.log(await storage.get(['a', 3, new Date(0)]));

Prerequisites

A URL to a database needs to be provided via environment variable alongside the following permissions (for SQLite adapters):

DENO_STORAGE_AREA__DEFAULT_URL=sqlite://database.sqlite deno run --allow-read --allow-write --allow-env mod.ts

There are other ways of providing the database URL:

• As a static variable:

  StorageArea.defaultURL = 'sqlite://database.sqlite';

• As a global variable:

  self['DENO_STORAGE_AREA__DEFAULT_URL'] = 'sqlite://database.sqlite';

• As a constructor argument:

  new StorageArea('default', { url: 'sqlite://database.sqlite' });

Features

Beyond the cross-worker-env aspects of using StorageArea, it aso provides a number of quality of life improvements over using other key value implementations:

• Wrapping and Unwrapping of many built-in types, such as Map and Set (Structured Clone Algorithm)
• Support for non-string keys and complex keys

Disclaimers

Note that efficiency is not a goal. Specifically, if you have sizable ArrayBuffers, it’s better to use a database implementation with proper support for binary data.

This module is part of the Worker Tools collection
⁕

Worker Tools are a collection of TypeScript libraries for writing web servers in Worker Runtimes such as Cloudflare Workers, Deno Deploy and Service Workers in the browser.

If you liked this module, you might also like:

• 🧭 Worker Router — Complete routing solution that works across CF Workers, Deno and Service Workers
• 🔋 Worker Middleware — A suite of standalone HTTP server-side middleware with TypeScript support
• 📄 Worker HTML — HTML templating and streaming response library
• 📦 Storage Area — Key-value store abstraction across Cloudflare KV, Deno and browsers.
• 🆗 Response Creators — Factory functions for responses with pre-filled status and status text
• 🎏 Stream Response — Use async generators to build streaming responses for SSE, etc…
• 🥏 JSON Fetch — Drop-in replacements for Fetch API classes with first class support for JSON.
• 🦑 JSON Stream — Streaming JSON parser/stingifier with first class support for web streams.

Worker Tools also includes a number of polyfills that help bridge the gap between Worker Runtimes:

• ✏️ HTML Rewriter — Cloudflare’s HTML Rewriter for use in Deno, browsers, etc…
• 📍 Location Polyfill — A Location polyfill for Cloudflare Workers.
• 🦕 Deno Fetch Event Adapter — Dispatches global fetch events using Deno’s native HTTP server.

Fore more visit workers.tools.