1 | # Storage Area
|
2 |
|
3 | Picks the platform-specific Storage Area ([1],[2],[3]) implementation for Deno, Cloudflare Workers and the browser.
|
4 |
|
5 | ```ts
|
6 | import { StorageArea } from '@worker-tools/kv-storage'
|
7 |
|
8 | const storage = new StorageArea('default')
|
9 | ```
|
10 |
|
11 | 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.
|
12 |
|
13 | ## Deno
|
14 | For use in **Deno** loading a storage adapter is required, e.g.
|
15 |
|
16 | ```ts
|
17 | import 'https://deno.land/x/kv_storage/adapters/sqlite.ts'
|
18 | // or dynamically:
|
19 | await import('https://deno.land/x/kv_storage/adapters/sqlite.ts')
|
20 | ```
|
21 |
|
22 | For details, see [the Deno module](https://workers.tools/deno-kv-storage).
|
23 |
|
24 |
|
25 | ## Cloudflare Workers
|
26 | For use in **Cloudflare Workers**, adding a KV binding is necessary.
|
27 |
|
28 | ```toml
|
29 | # file: "wrangler.toml"
|
30 | kv_namespaces = [
|
31 | { binding = "KV_STORAGE", id = "...", preview_id = "..." }
|
32 | ]
|
33 |
|
34 | [vars]
|
35 | DEFAULT_KV_NAMESPACE = "KV_STORAGE"
|
36 | ```
|
37 |
|
38 | For details, see [the Cloudflare module](https://workers.tools/cloudflare-kv-storage).
|
39 |
|
40 | ## Browsers
|
41 | 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.
|
42 |
|
43 | When using `esbuild` one way to achieve this is through a custom `tsconfig.json` file, e.g.:
|
44 |
|
45 | ```jsonc
|
46 | {
|
47 | "compilerOptions": {
|
48 | "paths": {
|
49 | "@worker-tools/kv-storage": ["./node_modules/@worker-tools/kv-storage-polyfill"],
|
50 | }
|
51 | }
|
52 | }
|
53 | ```
|
54 |
|
55 | 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.
|
56 |
|
57 |
|
58 | [1]: https://developers.google.com/web/updates/2019/03/kv-storage
|
59 | [2]: https://css-tricks.com/kv-storage/
|
60 | [3]: https://github.com/WICG/kv-storage
|
61 |
|
62 | <br/>
|
63 |
|
64 | --------
|
65 |
|
66 | <br/>
|
67 |
|
68 | <p align="center"><a href="https://workers.tools"><img src="https://workers.tools/assets/img/logo.svg" width="100" height="100" /></a>
|
69 | <p align="center">This module is part of the Worker Tools collection<br/>β
|
70 |
|
71 | [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.
|
72 |
|
73 | If you liked this module, you might also like:
|
74 |
|
75 | - π§ [__Worker Router__][router] --- Complete routing solution that works across CF Workers, Deno and Service Workers
|
76 | - π [__Worker Middleware__][middleware] --- A suite of standalone HTTP server-side middleware with TypeScript support
|
77 | - π [__Worker HTML__][html] --- HTML templating and streaming response library
|
78 | - π¦ [__Storage Area__][kv-storage] --- Key-value store abstraction across [Cloudflare KV][cloudflare-kv-storage], [Deno][deno-kv-storage] and browsers.
|
79 | - π [__Response Creators__][response-creators] --- Factory functions for responses with pre-filled status and status text
|
80 | - π [__Stream Response__][stream-response] --- Use async generators to build streaming responses for SSE, etc...
|
81 | - π₯ [__JSON Fetch__][json-fetch] --- Drop-in replacements for Fetch API classes with first class support for JSON.
|
82 | - π¦ [__JSON Stream__][json-stream] --- Streaming JSON parser/stingifier with first class support for web streams.
|
83 |
|
84 | Worker Tools also includes a number of polyfills that help bridge the gap between Worker Runtimes:
|
85 | - βοΈ [__HTML Rewriter__][html-rewriter] --- Cloudflare's HTML Rewriter for use in Deno, browsers, etc...
|
86 | - π [__Location Polyfill__][location-polyfill] --- A `Location` polyfill for Cloudflare Workers.
|
87 | - π¦ [__Deno Fetch Event Adapter__][deno-fetch-event-adapter] --- Dispatches global `fetch` events using Denoβs native HTTP server.
|
88 |
|
89 | [router]: https://workers.tools/router
|
90 | [middleware]: https://workers.tools/middleware
|
91 | [html]: https://workers.tools/html
|
92 | [kv-storage]: https://workers.tools/kv-storage
|
93 | [cloudflare-kv-storage]: https://workers.tools/cloudflare-kv-storage
|
94 | [deno-kv-storage]: https://workers.tools/deno-kv-storage
|
95 | [kv-storage-polyfill]: https://workers.tools/kv-storage-polyfill
|
96 | [response-creators]: https://workers.tools/response-creators
|
97 | [stream-response]: https://workers.tools/stream-response
|
98 | [json-fetch]: https://workers.tools/json-fetch
|
99 | [json-stream]: https://workers.tools/json-stream
|
100 | [request-cookie-store]: https://workers.tools/request-cookie-store
|
101 | [extendable-promise]: https://workers.tools/extendable-promise
|
102 | [html-rewriter]: https://workers.tools/html-rewriter
|
103 | [location-polyfill]: https://workers.tools/location-polyfill
|
104 | [deno-fetch-event-adapter]: https://workers.tools/deno-fetch-event-adapter
|
105 |
|
106 | Fore more visit [workers.tools](https://workers.tools). |
\ | No newline at end of file |