Partager via


Storage interface

Interface pour un fournisseur de stockage qui stocke et récupère les anciens objets JSON bruts.

Méthodes

delete(string[])

Supprime les éléments de stockage du stockage

read(string[])

Charge les éléments de stockage à partir du stockage

write(StoreItems)

Enregistre les éléments de stockage dans le stockage.

Détails de la méthode

delete(string[])

Supprime les éléments de stockage du stockage

function delete(keys: string[]): Promise<void>

Paramètres

keys

string[]

Tableau de clés d’élément à supprimer du magasin.

Retours

Promise<void>

Remarques

Cet exemple supprime un objet du stockage :

await storage.delete(['botState']);

read(string[])

Charge les éléments de stockage à partir du stockage

function read(keys: string[]): Promise<StoreItems>

Paramètres

keys

string[]

Tableau de clés d’élément à lire à partir du magasin.

Retours

Promise<StoreItems>

Remarques

Cet exemple lit dans un objet unique à partir du stockage :

const items = await storage.read(['botState']);
const state = items['botState'] || {};

write(StoreItems)

Enregistre les éléments de stockage dans le stockage.

function write(changes: StoreItems): Promise<void>

Paramètres

changes
StoreItems

Mappage d’éléments à écrire dans le stockage.

Retours

Promise<void>

Remarques

Cet exemple écrit un objet dans le stockage après sa modification :

state.topic = 'someTopic';
await storage.write({ 'botState': state });