Picks the platform-specific Storage Area (1,2,3) implementation for Deno, Cloudflare Workers and the browser.

import { StorageArea } from '@worker-tools/kv-storage'

const storage = new StorageArea('default')

The purpose of this module is to make it easier to write cross-runtime code, i.e. code that works on CF Workers and Deno and potentially even the browser.

For use in Deno loading a storage adapter is required, e.g.

import 'https://deno.land/x/kv_storage/adapters/sqlite.ts'
// or dynamically:
await import('https://deno.land/x/kv_storage/adapters/sqlite.ts')

For details, see the Deno module.

For use in Cloudflare Workers, adding a KV binding is necessary.

# file: "wrangler.toml"
kv_namespaces = [ 
  { binding = "KV_STORAGE", id = "...", preview_id = "..." }
]

[vars]
  DEFAULT_KV_NAMESPACE = "KV_STORAGE"

For details, see the Cloudflare module.

For use in Browsers/Service Workers where bundle size is critical, it's recommended to prevent your bundler from including the Deno and CF Workers specific parts.

When using esbuild one way to achieve this is through a custom tsconfig.json file, e.g.:

{
  "compilerOptions": {
    "paths": {
      "@worker-tools/kv-storage": ["./node_modules/@worker-tools/kv-storage-polyfill"],
    }
  }
}

This will instruct esbuild to replace the generic kv-storage module with the browser-specific one. Both export the same classes and types. Other bundlers have similar mechanisms.

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.