MemoryStorage class
ボットのメモリ ベースのストレージ プロバイダー。
注釈
このプロバイダーは、エミュレーターに対してローカルで実行するとき、または単体テストの一部として運用ストレージをシミュレートする場合に最も便利です。 次の特性があります。
- ボットの実行時に完全に空の状態で起動します。
- プロセスが終了すると、ストアに書き込まれたものは忘れられます。
- ストアに読み取りおよび書き込まれるオブジェクトは、ネットワーク ベースのストレージ プロバイダーを適切にシミュレートするために複製されます。
- 複製されたオブジェクトは、 を使用して
JSON.stringify()
シリアル化され、ネットワーク ベースのストレージ プロバイダーの使用時に発生する可能性のあるシリアル化関連の問題をキャッチします。
const { MemoryStorage } = require('botbuilder');
const storage = new MemoryStorage();
コンストラクター
Memory |
新しい MemoryStorage インスタンスを作成します。 |
メソッド
delete(string[]) | ストレージからストレージ項目を削除します。 |
read(string[]) | ストレージからストレージ項目を読み取ります。 |
write(Store |
ストレージ項目をストレージに書き込みます。 |
コンストラクターの詳細
MemoryStorage([key: string]: string)
新しい MemoryStorage インスタンスを作成します。
new MemoryStorage(memory?: [key: string]: string)
パラメーター
- memory
-
[key: string]: string
(省略可能) 項目の格納に使用するメモリ。 既定では、空の JSON オブジェクト {}
が作成されます。
メソッドの詳細
delete(string[])
ストレージからストレージ項目を削除します。
function delete(keys: string[]): Promise<void>
パラメーター
- keys
-
string[]
削除する StoreItems オブジェクトの キー。
戻り値
Promise<void>
非同期操作を表す promise。
read(string[])
ストレージからストレージ項目を読み取ります。
function read(keys: string[]): Promise<StoreItems>
パラメーター
- keys
-
string[]
読み取る StoreItems オブジェクトの キー。
戻り値
Promise<StoreItems>
読み取り項目。
write(StoreItems)
ストレージ項目をストレージに書き込みます。
function write(changes: StoreItems): Promise<void>
パラメーター
- changes
- StoreItems
書き込 む StoreItems 。キーによってインデックスが作成されます。
戻り値
Promise<void>
非同期操作を表す promise。