Edge KV API | Key-Value Storage for Edge Functions - Edge Security Acceleration

Constructeur

Crée une instance Edge KV pour un namespace spécifique.

Définition

const edgeKv = new EdgeKV({ namespace: "ns"});

Paramètres

Paramètre

Description

namespace

Nom du namespace créé dans la console.

get

Lit une valeur par clé dans un namespace.

Définition
```
get(key[, {type: "type"}])
```

Paramètres

Paramètre

Description

key

Clé à récupérer. Ce paramètre doit être une chaîne.

type

Format de la valeur retournée. Valeurs valides :

stream (par défaut) : retourne la valeur sous forme de ReadableStream.
text : retourne la valeur sous forme de chaîne.
json : analyse la valeur en tant que JSON et retourne un objet JavaScript.
arrayBuffer : retourne la valeur sous forme d'ArrayBuffer.

Valeur de retour
Retourne une Promise résolue avec la valeur :
- Résolue à undefined si la clé est introuvable.
- Rejetée en cas d'erreur.

Exemple

export default {
  fetch(request) {
    return handleRequest(request)
  }
}
async function handleRequest(request) {
  try {
    const edgeKV = new EdgeKV({ namespace: "ns" });
    let getType = { type: "text" };
    let value = await edgeKV.get("key", getType);
    if (value === undefined) {
      return "EdgeKV get: key not found";
    } else {
      return new Response(value);
    }
  } catch (e) {
    return "EdgeKV get error" + e;
  }
}

put

Écrit ou met à jour une paire clé-valeur dans un namespace.

Définition
```
put(key,value)
```

Paramètres

Paramètre

Description

key

Clé à écrire. Ce paramètre doit être une chaîne non vide.

value

Valeur à stocker. Taille maximale : 1,8 Mo. Types valides :

string
ReadableStream
ArrayBuffer
Response

Valeur de retour
Retourne une Promise résolue à la fin de l'opération :
- Résolue à undefined en cas de succès.
- Rejetée en cas d'erreur.

Exemple

export default {
  async fetch(request) {
    return handleRequest(request);
  }
}
async function handleRequest(request) {
  try {
    const edgeKV = new EdgeKV({ namespace: "ns" });
    let data = await edgeKV.put("put_string", "string_value")
    // await edgeKV.put("put_stream", new HTMLStream("test_stream", []));
    // await edgeKV.put("put_array_buffer", getArrayBuffer());
    // await edgeKV.put("put_array_buffer", new Response("test"));
    if (data === undefined) {
      return "EdgeKV put success\n";
    } else {
      return "EdgeKV put failed\n";
    }
  } catch (e) {
    return "EdgeKV put error" + e;
  }
}

delete

Supprime une paire clé-valeur d'un namespace.

Définition
```
delete(key)
```

Paramètres

Paramètre

Description

key

Clé à supprimer. Ce paramètre doit être une chaîne.

Valeur de retour
Retourne une Promise résolue à la fin de l'opération :
- Résolue à true en cas de succès.
- Résolue à false en cas d'échec.
- Rejetée en cas d'erreur.

Exemple

export default {
  async fetch(request) {
    return handleRequest(request);
  }
}
async function handleRequest() {
  try {
    const edgeKV = new EdgeKV({ namespace: "ns" });
    let resp = await edgeKV.delete("key");
    if (resp) {
      return "EdgeKV delete success";
    } else {
      return "EdgeKV delete failed";
    }
  }
  catch (e) {
    return "EdgeKV delete error" + e;
  }
}