AbstractCredentialStore: delete()

継承したクラスでこの関数を実装してください。

ユーザが持つ値を削除します。

この関数は非同期関数です。

構文

credentialsStore.delete(key) => Promise<boolean>
credentialsStore.delete(key, projection) => Promise<boolean>

引数

  • key: string

    ユーザの識別子です。

  • projection: { [key: string]: boolean | null }?

    削除するデータの対象を指定するためのマッピングです。

    • 既定では値全体を null で置き換えます。

    プロパティ値が true であれば、そのプロパティを削除します。プロパティ値が null であればプロパティ値を null で置き換えます。

返値: Promise<boolean>

削除に成功したかどうかを返すプロミスです。