JSPM

cf-workers-kv

0.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 574
  • Score
    100M100P100Q91245F
  • License MIT

Cloudflare workers KV with customizable backing store for testing.

Package Exports

  • cf-workers-kv

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cf-workers-kv) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cf-workers-kv

Build Status dependencies Status

Cloudflare workers KV with customizable backing store for testing.

Install

npm install cf-workers-kv

Usage

import { KV } from 'cf-workers-kv'

// In memory map backend, also supports AsyncMapLike inerface for backing stores
// with async get/put etc. https://npm.im/async-map-like
const backend = new Map()
const fruits = new KV(backend)

const key = 'apple:grannysmith'
const value = { name: 'Granny Smith', type: 'apple', color: 'green' }
const metadata = { name: 'Granny Smith' }

await fruits.put(key, JSON.stringify(value), { metadata })

const apple = await fruits.get(key, 'json')
console.log(apple) // { name: 'Granny Smith', type: 'apple', color: 'green' }

const apples = await fruits.list({ prefix: 'apple:' })
console.log(apples) // { keys: [{ name: 'apple:grannysmith', metadata: { name: 'Granny Smith' } }], list_complete: true }

await fruits.delete(key)

API

See Cloudflare Workers Runtime API docs.

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Alan Shaw