Storage interface
Interface para um provedor de armazenamento que armazena e recupera objetos JSON antigos simples.
Métodos
delete(string[]) | Remove itens de repositório do armazenamento |
read(string[]) | Carrega itens de repositório do armazenamento |
write(Store |
Salva itens de repositório no armazenamento. |
Detalhes do método
delete(string[])
Remove itens de repositório do armazenamento
function delete(keys: string[]): Promise<void>
Parâmetros
- keys
-
string[]
Matriz de chaves de item a serem removidas do repositório.
Retornos
Promise<void>
Comentários
Este exemplo exclui um objeto do armazenamento:
await storage.delete(['botState']);
read(string[])
Carrega itens de repositório do armazenamento
function read(keys: string[]): Promise<StoreItems>
Parâmetros
- keys
-
string[]
Matriz de chaves de item a serem lidas do repositório.
Retornos
Promise<StoreItems>
Comentários
Este exemplo lê em um único objeto do armazenamento:
const items = await storage.read(['botState']);
const state = items['botState'] || {};
write(StoreItems)
Salva itens de repositório no armazenamento.
function write(changes: StoreItems): Promise<void>
Parâmetros
- changes
- StoreItems
Mapa de itens a serem gravados no armazenamento.
Retornos
Promise<void>
Comentários
Este exemplo grava um objeto no armazenamento após sua modificação:
state.topic = 'someTopic';
await storage.write({ 'botState': state });