EdgeKV

Edge KV is a distributed key-value storage service that allows you to store data on CDNetworks’ edge nodes close to your users, enabling low-latency, high-availability, and strongly consistent data access. You can use Edge KV to store various types of data, such as:

• User session data
• Application configuration
• Cached data
• Other data that requires fast access

Constructor

Creates an Edge KV instance object.

Definition

new EdgeKV({ namespace: "your-namespace" });

Parameter Description

get()

Reads the value of the specified key from Edge KV.

Definition

get(key, { type: "text" })

Parameter Description

Return Value

Returns a Promise that you should await to ensure the operation is completed.

• If the key does not exist, null is returned.
• If an exception occurs that causes the get operation to fail, an error exception is rejected.

Code Example

addEventListener("fetch", event => {
  event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
  try {
    const edgeKV = new EdgeKV({ namespace: "your-namespace" });
    let value = await edgeKV.get("key");
    if (value === null) {
      return new Response("EdgeKV get: key not found", { status: 404 });
    } else {
      return new Response(value);
    }
  } catch (e) {
    return new Response("EdgeKV get error" + e.toString(), { status: 500 });
  }
}

put()

Creates a new key-value pair, or updates the value of an existing key.

Definition

put(key, value, { expiration: secondsSinceEpoch })

Parameter Description

Return Value

Returns a Promise that you should await to ensure the operation is completed:

• If the operation is successful, true is resolved.
• If an exception occurs that causes the put operation to fail, an error exception is rejected.

Code Example

addEventListener("fetch", event => {
  event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
  try {
    const edgeKV = new EdgeKV({ namespace: "your-namespace" });
    await edgeKV.put("key", "value");
    return new Response("EdgeKV put success");
  } catch (e) {
    return new Response("EdgeKV put error" + e.toString(), { status: 500 });
  }
}

delete()

Deletes the specified key and its corresponding value.

Definition

delete(key)

Parameter Description

Return Value

Returns a Promise that you should await to ensure the operation is completed:

• If the delete operation is successful, true is resolved.
• If an exception occurs that causes the delete operation to fail, an error exception is rejected.

Code Example

addEventListener("fetch", event => {
  event.respondWith(handleRequest(event.request))
})

async function handleRequest(request) {
  try {
    const edgeKV = new EdgeKV({ namespace: "your-namespace" });
    await edgeKV.delete("key");
    return new Response("EdgeKV delete success");
  } catch (e) {
    return new Response("EdgeKV delete error" + e.toString(), { status: 500 });
  }
}

list()

Enumerates keys within the namespace that meet the specified criteria.

Definition

list({ startKey: "key1", endKey: "key2", limit: 10 })

Parameter Description

Return Value

Returns a Promise that you should await to ensure the operation is completed:

• If the list operation is successful, an array of keys is resolved.
• If an exception occurs that causes the list operation to fail, an error exception is rejected.

Code Example

addEventListener("fetch", event => {
  event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
  try {
    const edgeKV = new EdgeKV({ namespace: "your-namespace" });
    const keys = await edgeKV.list({ startKey: "key1", endKey: "key2", limit: 10 });
    for (let k of keys) {
      console.log(k);
    }
    return new Response("EdgeKV List success");
  } catch (e) {
    return new Response("EdgeKV List error" + e.toString(), { status: 500 });
  }
}

count()

Counts the number of keys within the namespace that meet the specified criteria.

Definition

count({ startKey: "key1", endKey: "key2" })

Parameter Description

Return Value

Returns a Promise that you should await to ensure the operation is completed:

• If the count operation is successful, an integer representing the number of keys is resolved.
• If an exception occurs that causes the count operation to fail, an error exception is rejected.

Code Example

addEventListener("fetch", event => {
  event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
  try {
    const edgeKV = new EdgeKV({ namespace: "your-namespace" });
    const keyNum = await edgeKV.count({ startKey: "key1", endKey: "key2" });
    return new Response(`EdgeKV Count success: ${keyNum}`);
  } catch (e) {
    return new Response("EdgeKV Count error" + e.toString(), { status: 500 });
  }
}