Users: removeUser()

ユーザをテーブルから削除します。

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

構文

Users.removeUser(userId) => Promise<boolean>
Users.removeUser(userId, options) => Promise<boolean>

引数

• userId: string

  削除するユーザの識別子です。

• options: { [tableName] }?

  オプション引数です。

  • tableName: string?

    registerTable() で登録されたテーブル名です。

    • 既定では最初に登録されたテーブルが使用されます。

返値: Promise<boolean>

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

例外

• TypeError
  • userId が文字列以外だった場合。

解説

tableName からテーブル AbstractCredentialStore を取得後、そのテーブルの削除メソッド AbstractCredentialStore::remove() でユーザを削除します。

返値は AbstractCredentialStore::remove() の結果と同じ値です。