1 | # Deno Storage Area
|
2 |
|
3 | An implementation of the StorageArea ([1],[2],[3]) interface for Deno with an extensible system for supporting various database backends.
|
4 |
|
5 | The goal of this class is ease of use and compatibility with other Storage Area implementations,
|
6 | such as [`kv-storage-polyfill`](https://github.com/GoogleChromeLabs/kv-storage-polyfill).
|
7 |
|
8 | While work on [the specification](https://wicg.github.io/kv-storage/) itself has stopped,
|
9 | KV Storage is still a good interface for asynchronous data access that feels native to JavaScript.
|
10 |
|
11 | ## Example
|
12 |
|
13 | ```ts
|
14 | // file: "mod.ts"
|
15 | import { StorageArea } from 'https://deno.land/x/kv_storage/sqlite.ts';
|
16 |
|
17 | const storage = new StorageArea();
|
18 |
|
19 | await storage.set(['a', 3, new Date(0)], {
|
20 | foo: 'bar',
|
21 | fizz: new Set(['buzz']),
|
22 | xyz: new Uint8Array([255]),
|
23 | });
|
24 |
|
25 | console.log(await storage.get(['a', 3, new Date(0)]));
|
26 | ```
|
27 |
|
28 | ## Prerequisites
|
29 |
|
30 | A URL to a database needs to be provided via environment variable alongside the following permissions (for SQLite adapters):
|
31 |
|
32 | DENO_STORAGE_AREA__DEFAULT_URL=sqlite://database.sqlite deno run --allow-read --allow-write --allow-env mod.ts
|
33 |
|
34 | There are other ways of providing the database URL:
|
35 |
|
36 | * As a static variable:
|
37 |
|
38 | ```ts
|
39 | StorageArea.defaultURL = 'sqlite://database.sqlite';
|
40 | ```
|
41 |
|
42 | * As a global variable:
|
43 |
|
44 | ```ts
|
45 | self['DENO_STORAGE_AREA__DEFAULT_URL'] = 'sqlite://database.sqlite';
|
46 | ```
|
47 |
|
48 | * As a constructor argument:
|
49 |
|
50 | ```ts
|
51 | new StorageArea('default', { url: 'sqlite://database.sqlite' });
|
52 | ```
|
53 |
|
54 |
|
55 | [1]: https://developers.google.com/web/updates/2019/03/kv-storage
|
56 | [2]: https://css-tricks.com/kv-storage/
|
57 | [3]: https://github.com/WICG/kv-storage
|
58 |
|
59 | ## Features
|
60 |
|
61 | 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:
|
62 |
|
63 | * Wrapping and Unwrapping of many built-in types, such as `Map` and `Set` (Structured Clone Algorithm)
|
64 | * Support for non-string keys and complex keys
|
65 |
|
66 | ## Disclaimers
|
67 |
|
68 | Note that efficiency is not a goal. Specifically, if you have sizable `ArrayBuffer`s,
|
69 | it's better to use a database implementation with proper support for binary data.
|
70 |
|
71 | <br/>
|
72 |
|
73 | --------
|
74 |
|
75 | <br/>
|
76 |
|
77 | <p align="center"><a href="https://workers.tools"><img src="https://workers.tools/assets/img/logo.svg" width="100" height="100" /></a>
|
78 | <p align="center">This module is part of the Worker Tools collection<br/>β
|
79 |
|
80 | [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.
|
81 |
|
82 | If you liked this module, you might also like:
|
83 |
|
84 | - π§ [__Worker Router__][router] --- Complete routing solution that works across CF Workers, Deno and Service Workers
|
85 | - π [__Worker Middleware__][middleware] --- A suite of standalone HTTP server-side middleware with TypeScript support
|
86 | - π [__Worker HTML__][html] --- HTML templating and streaming response library
|
87 | - π¦ [__Storage Area__][kv-storage] --- Key-value store abstraction across [Cloudflare KV][cloudflare-kv-storage], [Deno][deno-kv-storage] and browsers.
|
88 | - π [__Response Creators__][response-creators] --- Factory functions for responses with pre-filled status and status text
|
89 | - π [__Stream Response__][stream-response] --- Use async generators to build streaming responses for SSE, etc...
|
90 | - π₯ [__JSON Fetch__][json-fetch] --- Drop-in replacements for Fetch API classes with first class support for JSON.
|
91 | - π¦ [__JSON Stream__][json-stream] --- Streaming JSON parser/stingifier with first class support for web streams.
|
92 |
|
93 | Worker Tools also includes a number of polyfills that help bridge the gap between Worker Runtimes:
|
94 | - βοΈ [__HTML Rewriter__][html-rewriter] --- Cloudflare's HTML Rewriter for use in Deno, browsers, etc...
|
95 | - π [__Location Polyfill__][location-polyfill] --- A `Location` polyfill for Cloudflare Workers.
|
96 | - π¦ [__Deno Fetch Event Adapter__][deno-fetch-event-adapter] --- Dispatches global `fetch` events using Denoβs native HTTP server.
|
97 |
|
98 | [router]: https://workers.tools/router
|
99 | [middleware]: https://workers.tools/middleware
|
100 | [html]: https://workers.tools/html
|
101 | [kv-storage]: https://workers.tools/kv-storage
|
102 | [cloudflare-kv-storage]: https://workers.tools/cloudflare-kv-storage
|
103 | [deno-kv-storage]: https://workers.tools/deno-kv-storage
|
104 | [kv-storage-polyfill]: https://workers.tools/kv-storage-polyfill
|
105 | [response-creators]: https://workers.tools/response-creators
|
106 | [stream-response]: https://workers.tools/stream-response
|
107 | [json-fetch]: https://workers.tools/json-fetch
|
108 | [json-stream]: https://workers.tools/json-stream
|
109 | [request-cookie-store]: https://workers.tools/request-cookie-store
|
110 | [extendable-promise]: https://workers.tools/extendable-promise
|
111 | [html-rewriter]: https://workers.tools/html-rewriter
|
112 | [location-polyfill]: https://workers.tools/location-polyfill
|
113 | [deno-fetch-event-adapter]: https://workers.tools/deno-fetch-event-adapter
|
114 |
|
115 | Fore more visit [workers.tools](https://workers.tools). |
\ | No newline at end of file |