Storage interface
プレーンな古い JSON オブジェクトを格納および取得するストレージ プロバイダーのインターフェイス。
メソッド
| delete(string[]) | ストレージからストア アイテムを削除します |
| read(string[]) | ストレージからストア アイテムを読み込みます |
| write(Store |
ストア アイテムをストレージに保存します。 |
メソッドの詳細
delete(string[])
ストレージからストア アイテムを削除します
function delete(keys: string[]): Promise<void>パラメーター
- keys
-
string[]
ストアから削除する項目キーの配列。
戻り値
Promise<void>
注釈
次の使用例は、ストレージからオブジェクトを削除します。
await storage.delete(['botState']);
read(string[])
ストレージからストア アイテムを読み込みます
function read(keys: string[]): Promise<StoreItems>パラメーター
- keys
-
string[]
ストアから読み取る項目キーの配列。
戻り値
Promise<StoreItems>
注釈
次の例では、ストレージから 1 つのオブジェクトを読み取ります。
const items = await storage.read(['botState']);
const state = items['botState'] || {};
write(StoreItems)
ストア アイテムをストレージに保存します。
function write(changes: StoreItems): Promise<void>パラメーター
- changes
- StoreItems
ストレージに書き込む項目のマップ。
戻り値
Promise<void>
注釈
次の例では、オブジェクトが変更された後、ストレージにオブジェクトを書き込みます。
state.topic = 'someTopic';
await storage.write({ 'botState': state });