https://github.com/ariesclark/cloudflare-kv-storage

A dead simple client for Cloudflare's KV storage. 📦
https://github.com/ariesclark/cloudflare-kv-storage

cloudflare database key kv kv-store store value

Last synced: about 2 months ago
JSON representation

A dead simple client for Cloudflare's KV storage. 📦

• Host: GitHub
• URL: https://github.com/ariesclark/cloudflare-kv-storage
• Owner: ariesclark
• License: mit
• Created: 2022-02-26T10:21:26.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-21T08:39:35.000Z (about 1 year ago)
• Last Synced: 2024-10-27T18:54:37.147Z (3 months ago)
• Topics: cloudflare, database, key, kv, kv-store, store, value
• Language: TypeScript
• Homepage: https://npm.im/cloudflare-kv-storage
• Size: 77.1 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Cloudflare KV Storage 📦

A dead simple client for Cloudflare's KV storage.

![Maintenance](https://img.shields.io/maintenance/yes/2023) [![GitHub](https://img.shields.io/github/license/ariesclark/cloudflare-kv-storage) ![GitHub issues](https://img.shields.io/github/issues/ariesclark/cloudflare-kv-storage) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ariesclark/cloudflare-kv-storage)](https://github.com/ariesclark/cloudflare-kv-storage)

 [![npm downloads](https://img.shields.io/npm/dm/cloudflare-kv-storage) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/cloudflare-kv-storage)](https://www.npmjs.com/package/cloudflare-kv-storage)

## Usage

```ts

import { CloudflareKV } from "cloudflare-kv-storage";

const kv = new CloudflareKV({

	accountId: process.env.CLOUDFLARE_ACCOUNT_ID,

	namespaceId: process.env.CLOUDFLARE_NAMESPACE_ID,

	accessToken: process.env.CLOUDFLARE_ACCESS_TOKEN

});

// or you can directly import "kv" which uses the 

// environment variables by default.

import { kv } from "cloudflare-kv-storage";

await kv.set("foo", "hello", { expiration_ttl: "10m" });

await kv.set("bar", "world", { expiration: Date.now() + 10000 });

await kv.set("baz", "bin");

await kv.get("bar") // "world"

await kv.delete("foo");

await kv.list();

// will return something like:

{

    result: [

        {

            name: "bar",

            expiration: 1646499225

        },

        {

            name: "baz"

        }

    ],

    success: true,

    errors: [],

    messages: [],

    result_info: {

        count: 2,

        cursor: ""

    }

}

```