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.
yarn add @adaptivelink/kvnpm i @adaptivelink/kvYou 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.
importKVfrom"@adaptivelink/kv";constNAMESPACE=newKV("namespace");consthandleRequest=async(event)=>{constkeyValue=awaitNAMESPACE.get("key");event.waitUntil(awaitNAMESPACE.put("hello","world"));};...
constNAMESPACE=newKV("namespace",{passphrase: KV_NAMESPACE_PASSPHRASE,});
...await NAMESPACE.put(key, value)
await NAMESPACE.get(key)
await NAMESPACE.get(key)
🌐 Tested Vendors
| Vendor | Data Consistency |
|---|---|
| AWS S3 | strong read-after-write |
| Wasabi | subsecond read-after-write consistency |
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.
Feel free to contribute with more features, documentation, and test with more vendors. Send your feedback.