@adaptivelink/kv v0.2.1
KV Utility
A KV storage solution for Cloudflare Workers and Stackpath Serverless Scripting, that uses S3 providers as vendors, like AWS, Wasabi. Optionally you can encrypt your values at rest.
šØ Install with yarn
or npm
yarn add @adaptivelink/kv
npm i @adaptivelink/kv
āļø Environment Variables
You need to configured the variables (Environment or Global) with your vendor data.
- KV_ACCESS_KEY_ID
- KV_SECRET_ACCESS_KEY š
- KV_DEFAULT_REGION
- KV_S3_BUCKET
- KV_NAMESPACE_PASSPHRASE š (optional)
š Should be stored as environment encrypted variable, avoid global variable.
š Basic Usage in Cloudflare & Stackpath
import KV from "@adaptivelink/kv";
const NAMESPACE = new KV("namespace");
const handleRequest = async (event) => {
const keyValue = await NAMESPACE.get("key");
event.waitUntil(await NAMESPACE.put("hello", "world"));
};
š Usage with Encrypted Values
...
const NAMESPACE = new KV("namespace", {
passphrase: KV_NAMESPACE_PASSPHRASE,
});
...
š© Methods
Writing Key-value pair
await NAMESPACE.put(key, value)
Reading Key-value pair
await NAMESPACE.get(key)
Deleting Key-value pair
await NAMESPACE.get(key)
š Tested Vendors
Vendor | Data Consistency |
---|---|
AWS S3 | strong read-after-write |
Wasabi | subsecond read-after-write consistency |
ā ļø Security Disclaimer
This software offers no guarantees, we strongly advise that you audit the code.
When using encrypted KV option, only the values are encrypted with AES-GCM algorithm. That data is stored at the vendor encrypted, but encrypted/decrypted by the āļø Worker script, meaning that the Isolate will have full access to the values. It would help if you referred to your serverless provider's terms to analyse their scope of access.
š„° Contribution
Feel free to contribute with more features, documentation, and test with more vendors. Send your feedback.