{"id":20563836,"url":"https://github.com/worker-tools/kv-storage","last_synced_at":"2025-04-14T14:53:49.648Z","repository":{"id":57684648,"uuid":"495028912","full_name":"worker-tools/kv-storage","owner":"worker-tools","description":"Picks the platform-specific Storage Area implementation for Deno, Cloudflare Workers and the browser.","archived":false,"fork":false,"pushed_at":"2022-05-31T09:51:20.000Z","size":11,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T03:51:06.072Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://workers.tools/kv-storage","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/worker-tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-22T10:37:38.000Z","updated_at":"2023-05-14T11:16:43.000Z","dependencies_parsed_at":"2022-09-17T00:23:06.720Z","dependency_job_id":null,"html_url":"https://github.com/worker-tools/kv-storage","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/worker-tools%2Fkv-storage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/worker-tools%2Fkv-storage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/worker-tools%2Fkv-storage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/worker-tools%2Fkv-storage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/worker-tools","download_url":"https://codeload.github.com/worker-tools/kv-storage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248901350,"owners_count":21180393,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T04:21:21.891Z","updated_at":"2025-04-14T14:53:49.625Z","avatar_url":"https://github.com/worker-tools.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Storage Area\n\nPicks the platform-specific Storage Area ([1],[2],[3]) implementation for Deno, Cloudflare Workers and the browser.\n\n```ts\nimport { StorageArea } from '@worker-tools/kv-storage'\n\nconst storage = new StorageArea('default')\n```\n\nThe 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.\n\n## Deno\nFor use in **Deno** loading a storage adapter is required, e.g.\n\n```ts\nimport 'https://deno.land/x/kv_storage/adapters/sqlite.ts'\n// or dynamically:\nawait import('https://deno.land/x/kv_storage/adapters/sqlite.ts')\n```\n\nFor details, see [the Deno module](https://workers.tools/deno-kv-storage).\n\n\n## Cloudflare Workers\nFor use in **Cloudflare Workers**, adding a KV binding is necessary. \n\n```toml\n# file: \"wrangler.toml\"\nkv_namespaces = [ \n  { binding = \"KV_STORAGE\", id = \"...\", preview_id = \"...\" }\n]\n\n[vars]\n  DEFAULT_KV_NAMESPACE = \"KV_STORAGE\"\n```\n\nFor details, see [the Cloudflare module](https://workers.tools/cloudflare-kv-storage).\n\n## Browsers\nFor 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.\n\nWhen using `esbuild` one way to achieve this is through a custom `tsconfig.json` file, e.g.:\n\n```jsonc\n{\n  \"compilerOptions\": {\n    \"paths\": {\n      \"@worker-tools/kv-storage\": [\"./node_modules/@worker-tools/kv-storage-polyfill\"],\n    }\n  }\n}\n```\n\nThis 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.\n\n\n[1]: https://developers.google.com/web/updates/2019/03/kv-storage\n[2]: https://css-tricks.com/kv-storage/\n[3]: https://github.com/WICG/kv-storage\n\n\u003cbr/\u003e\n\n--------\n\n\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://workers.tools\"\u003e\u003cimg src=\"https://workers.tools/assets/img/logo.svg\" width=\"100\" height=\"100\" /\u003e\u003c/a\u003e\n\u003cp align=\"center\"\u003eThis module is part of the Worker Tools collection\u003cbr/\u003e⁕\n\n[Worker Tools](https://workers.tools) are a collection of TypeScript libraries for writing web servers in [Worker Runtimes](https://workers.js.org) such as Cloudflare Workers, Deno Deploy and Service Workers in the browser. \n\nIf you liked this module, you might also like:\n\n- 🧭 [__Worker Router__][router] --- Complete routing solution that works across CF Workers, Deno and Service Workers\n- 🔋 [__Worker Middleware__][middleware] --- A suite of standalone HTTP server-side middleware with TypeScript support\n- 📄 [__Worker HTML__][html] --- HTML templating and streaming response library\n- 📦 [__Storage Area__][kv-storage] --- Key-value store abstraction across [Cloudflare KV][cloudflare-kv-storage], [Deno][deno-kv-storage] and browsers.\n- 🆗 [__Response Creators__][response-creators] --- Factory functions for responses with pre-filled status and status text\n- 🎏 [__Stream Response__][stream-response] --- Use async generators to build streaming responses for SSE, etc...\n- 🥏 [__JSON Fetch__][json-fetch] --- Drop-in replacements for Fetch API classes with first class support for JSON.\n- 🦑 [__JSON Stream__][json-stream] --- Streaming JSON parser/stingifier with first class support for web streams.\n\nWorker Tools also includes a number of polyfills that help bridge the gap between Worker Runtimes:\n- ✏️ [__HTML Rewriter__][html-rewriter] --- Cloudflare's HTML Rewriter for use in Deno, browsers, etc...\n- 📍 [__Location Polyfill__][location-polyfill] --- A `Location` polyfill for Cloudflare Workers.\n- 🦕 [__Deno Fetch Event Adapter__][deno-fetch-event-adapter] --- Dispatches global `fetch` events using Deno’s native HTTP server.\n\n[router]: https://workers.tools/router\n[middleware]: https://workers.tools/middleware\n[html]: https://workers.tools/html\n[kv-storage]: https://workers.tools/kv-storage\n[cloudflare-kv-storage]: https://workers.tools/cloudflare-kv-storage\n[deno-kv-storage]: https://workers.tools/deno-kv-storage\n[kv-storage-polyfill]: https://workers.tools/kv-storage-polyfill\n[response-creators]: https://workers.tools/response-creators\n[stream-response]: https://workers.tools/stream-response\n[json-fetch]: https://workers.tools/json-fetch\n[json-stream]: https://workers.tools/json-stream\n[request-cookie-store]: https://workers.tools/request-cookie-store\n[extendable-promise]: https://workers.tools/extendable-promise\n[html-rewriter]: https://workers.tools/html-rewriter\n[location-polyfill]: https://workers.tools/location-polyfill\n[deno-fetch-event-adapter]: https://workers.tools/deno-fetch-event-adapter\n\nFore more visit [workers.tools](https://workers.tools).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworker-tools%2Fkv-storage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworker-tools%2Fkv-storage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworker-tools%2Fkv-storage/lists"}