Key-value accessors

To access key-value pairs in a KV Store. First create a KV Instance using KvStore.open()

This instance provides get and getEntry for retrieving a value by key, and scan for enumerating keys by prefix.

get

import { KvStore } from 'fastedge::kv';

async function eventHandler(event) {
  try {
    const myStore = KvStore.open('kv-store-name-as-defined-on-app');
    const value = myStore.get('key');
    return new Response(value);
  } catch (error) {
    return Response.json({ error: error.message }, { status: 500 });
  }
}

addEventListener('fetch', (event) => {
  event.respondWith(eventHandler(event));
});

storeInstance.get(key);

Parameters

key (required)

A string containing the key you want to retrieve the value of.

Return Value

An ArrayBuffer of the value for the given key. If the key does not exist, null is returned. To decode the bytes as a string or JSON, either use getEntry or wrap the result with a TextDecoder.

getEntry

import { KvStore } from 'fastedge::kv';

async function eventHandler(event) {
  try {
    const myStore = KvStore.open('kv-store-name-as-defined-on-app');
    const entry = await myStore.getEntry('key');

    if (entry === null) {
      return new Response('Key not found', { status: 404 });
    }

    return new Response(`The KV Store responded with: ${await entry.text()}`);
  } catch (error) {
    return Response.json({ error: error.message }, { status: 500 });
  }
}

addEventListener('fetch', (event) => {
  event.respondWith(eventHandler(event));
});

storeInstance.getEntry(key);

Parameters

key (required)

A string containing the key you want to retrieve the value of.

Return Value

A Promise<KvStoreEntry | null>. The entry exposes arrayBuffer(), text(), and json() accessor methods, each returning a Promise. If the key does not exist, the Promise resolves to null.

scan

import { KvStore } from 'fastedge::kv';

async function eventHandler(event) {
  try {
    const myStore = KvStore.open('kv-store-name-as-defined-on-app');
    const results = myStore.scan('pre*');
    return new Response(`The KV Store responded with: ${results.join(', ')}`);
  } catch (error) {
    return Response.json({ error: error.message }, { status: 500 });
  }
}

addEventListener('fetch', (event) => {
  event.respondWith(eventHandler(event));
});

storeInstance.scan(pattern);

Parameters

pattern (required)

A string containing the prefix pattern match.

Note: This is a prefix match, it must contain the wildcard *. In the given example it matches all keys that start with pre

Return Value

An Array<string> of all the keys that match the given pattern. If no matches are found it returns an empty array.